ServiceControl instances

Component: ServiceControl

ServiceControl instances collect and analyze data about the endpoints that make up a system and the messages flowing between them. This data is exposed to ServiceInsight and ServicePulse via an HTTP API and SignalR, and via external integration events.

The ServiceControl HTTP API is designed for use by ServicePulse and ServiceInsight only and may change at any time. Use of this HTTP API for other purposes is discouraged.
graph LR subgraph Endpoints Audit Error Plugins[Heartbeats<br>Custom Checks<br>Saga Audit] end Audit -- Audit<br>Data --> AuditQ[Audit Queue] Error -- Error<br>Data --> ErrorQ[Error Queue] Plugins -- Plugin<br>Data --> SCQ SCQ[ServiceControl<br>Input Queue] --> SC[ServiceControl<br>Instance] AuditQ --> SC ErrorQ --> SC ServicePulse -.-> SC ServiceInsight -.-> SC SC --> AuditLog[Audit.Log<br>Queue] SC --> ErrorLog[Error.Log<br>Queue] SC -. Integration<br>Events .-> Watchers[Alert<br>Subscribers]

Each endpoint in the system should be configured to send audit copies of every message that is processed into a central audit queue. A ServiceControl instance reads the messages in the audit queue and makes them available for visualization in ServiceInsight. ServiceControl can optionally forward these messages into an Audit Log queue for further processing if required.

Each endpoint in the system should be configured to send failed messages to a central error queue after those messages have gone through immediate and delayed retries. A ServiceControl instance reads the messages in the error queue and makes them available to be retried manually in ServicePulse and ServiceInsight. ServiceControl can optionally forward these messages into an Error Log queue for further processing if required.

Each endpoint may have additional plugins installed which collect and send data to a ServiceControl instance. See ServiceControl Endpoint Plugins for a complete list.

Each ServiceControl instance raises external integration events when important situations are detected. These are standard NServiceBus events that can be subscribed to by any NServiceBus endpoint. See Use ServiceControl events for a complete list.

Each ServiceControl instance stores data in an embedded database. Audit data is retained for 30 days. Failed message data is retained until the message is retried or manually archived. These retention periods can be customized.

Each environment should have a single audit queue and a single error queue that all endpoints are configured to use. Each environment should have a single ServiceControl instance that is connected to it's audit and error queues. Consider the advice given in the Planning section of the documentation before creating a new ServiceControl instance.


Last modified