# ServiceControl-Audit

ServiceControl-Audit is the audit instance of Particular ServiceControl, a monitoring component for NServiceBus distributed systems that records a complete history of every message that flows through your platform. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1339/servicecontrol-audit

## Description

ServiceControl Audit is the audit instance of Particular ServiceControl, a monitoring component for NServiceBus distributed systems that records a complete history of every message that flows through your platform. It stores that audit trail in a RavenDB-backed database, scales out to multiple audit instances for high message volume, and exposes the records over a HyperText Transfer Protocol (HTTP) API so you can search, inspect, and replay individual messages in ServicePulse and ServiceInsight. It suits teams running NServiceBus who need a durable, replayable message log for debugging and incident investigation.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

59/100 (Fair), based on 4 of 4 factors.
- Maintained: 100 (last commit 14 days ago)
- Popular: 36 (60 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 20 (16 GB minimum RAM, runs on ARM)

## Links

- Docker Hub: https://hub.docker.com/r/particular/servicecontrol-audit
- Unraid: https://ca.unraid.net/apps/servicecontrol-audit-1jseydz1z0nkib?q=ServiceControl-Audit
- Official website: https://docs.particular.net
- Documentation: https://docs.particular.net/servicecontrol/ravendb/containers

## Common questions

### Which ports should be set when creating a ServiceControl.Audit instance?

Set the instance ports before starting it, along with the install, database, and log paths. The example uses 44334 for the main port and 44335 for database maintenance.

### What authentication setting must not be left blank when enabling OpenID Connect?

Enter the OpenID Connect authority and the other required authentication values. If the authority is blank, the instance fails to start.

### What RavenDB version do new ServiceControl.Audit instances use from v4.26 onward?

New audit instances from v4.26 onward use RavenDB 5.4 instead of RavenDB 3.5. Upgrading and recreating an instance may be relevant when disk space is not freed after compacting.

### Are Helm templates available for deploying ServiceControl.Audit on Kubernetes?

Helm template examples are available for deploying ServiceControl.Audit and related Particular Platform components on Kubernetes. They are intended to make installation and configuration easier.

### Why might a newly installed ServiceControl.Audit v4.26.0 instance crash immediately after startup?

One instance crashed immediately after startup when installed with the audit -add PowerShell script using settings from an older instance.

---
Source: Our Local Host (https://ourlocalhost.com/app/1339/servicecontrol-audit), the self-hosted and open-source app directory.