Getting Started

Connect to ServicePlatform using the .NET Generic Host

NuGet Package: NServiceBus.ServicePlatform.Connector (3.x)
Target Version: NServiceBus 9.x


This sample connects an NServiceBus endpoint hosted in the .NET Generic Host to the Particular Service Platform and configures:

  • An error queue
  • Message auditing
  • Saga auditing
  • Endpoint heartbeats
  • Custom checks
  • Performance metrics

Code walk-through


A basic NServiceBus endpoint containing a saga, a handler, and a custom check. The endpoint is hosted in a .NET Generic Host.

The host is configured to include a JSON configuration file. The configuration can come from any provider supported by the configuration framework.


The endpoint loads connection details from a configuration section.

var platformConnection = hostBuilder.Configuration

The connection details are used to configure all of the Particular Service Platform features.


Features can be turned on and off, and configured, by adjusting the configuration at deployment.

  "ServicePlatformConfiguration": {
    "ErrorQueue": "error",
    "Heartbeats": {
      "Enabled": true,
      "HeartbeatsQueue": "Particular.ServiceControl"
    "CustomChecks": {
      "Enabled": true,
      "CustomChecksQueue": "Particular.ServiceControl"
    "MessageAudit": {
      "Enabled": true,
      "AuditQueue": "audit"
    "SagaAudit": {
      "Enabled": true,
      "SagaAuditQueue": "audit"
    "Metrics": {
      "Enabled": true,
      "MetricsQueue": "Particular.Monitoring",
      "Interval": "00:00:01",
      "InstanceId": "UniqueInstanceId"

Note that configuration details are stored in a section called ServicePlatformConfiguration which is the same key used above to retrieve them.

Endpoint features

The endpoint contains:

  • A saga that processes messages triggered generated 5 times per second, sends a request to a message handler, and waits for a result before marking the saga instance as complete. Connect ServiceInsight to the ServiceControl instance created by PlatformLauncher to view saga audit data.
  • A custom check that toggles the state between success and failure every 30 seconds. Check the Custom Checks tab in ServicePulse to see failures reported here.
  • A message handler that waits half a second before returning a response. This simulates real-world message processing in the Monitoring tab of ServicePulse.


Sets up three instances of ServiceControl (Primary, Audit, and Monitoring) and runs ServicePulse connected to all three.

Running the sample

Run the sample. Once running, a message is generated once every 200ms. Each message will trigger a saga, which will send a request message to a message handler and wait for a response.

Note the ServiceControl API address in the PlatformLauncher window to connect ServiceInsight to the sample and view message audit and saga audit details.

Related Articles