Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 3.06 KB

index.md

File metadata and controls

59 lines (38 loc) · 3.06 KB
Raw
title summary reviewed component redirects
ServiceControl Audit instances
Information about ServiceControl Audit instances
2024-07-19
ServiceControl
servicecontrol/audit-instances/persistence

Each endpoint in the system can be configured to send audit copies of every message that is processed into a central audit queue. ServiceControl Audit instances consume and store the messages sent to the audit queue and make them available for visualizing message flows in ServiceInsight.

ServiceControl Audit can optionally forward these messages into an audit log queue for further processing if required.

graph LR
  Endpoints -- Audit<br>Data --> AuditQ[Audit Queue]

  SCA[ServiceControl Audit<br>instance]
  SC[ServiceControl<br>Instance]
  AuditQ --> SCA

  ServiceInsight -.-> SC
  SCA --> AuditLog[Audit.Log<br>Queue]

  SC -. HTTP Queries .-> SCA
  SCA -- Notifications --> SC
Loading

Data about audit messages is exposed via an HTTP API from a ServiceControl Error instance, which aggregates the data stored in all connected ServiceControl Audit instances.

Important

Connecting ServiceInsight directly to a ServiceControl Audit instance is not supported.

Note

The ServiceControl HTTP API is designed for use by ServiceInsight only and may change at any time. Use of this HTTP API for other purposes is discouraged.

Persistence

Each ServiceControl Audit instance stores message data in a RavenDB database. For instances deployed using the ServiceControl Management utility or PowerShell this database is embedded with the ServiceControl Audit instance. For ServiceControl Audit instances deployed using containers the database resides in a separate container.

By default, audit data is retained for 30 days. This retention period can be customized.

include: ravendb-exclusive-use-warning

RavenDB versions used

In ServiceControl.Audit version 4.26 and above new instances use RavenDB version 5. Instances created by version 4.25 and below use RavenDB version 3.5.

Upgrading ServiceControl.Audit instances to version 4.26 or higher does not change the database version. Instances using RavenDB version 3.5, when upgraded to the newest version, will still use RavenDB version 3.5. For more details see upgrade guide to new persistence format

Notifications

Each ServiceControl Audit instance sends notification messages to a ServiceControl Error instance.

Endpoint detection

When a ServiceControl Audit instance detects a new endpoint, it sends a notification to the ServiceControl Error instance. The Error instance keeps track of all of the endpoints in the system and can monitor them with heartbeats and custom checks.

include: servicecontrol-self-monitoring