Transport configuration

ServiceControl can be configured to use one of the supported message transports which are configured for each instance type using the following settings:

• ServiceControl (Error) instance: ServiceControl/TransportType
• Audit instance: ServiceControl.Audit/TransportType
• Monitoring instance: Monitoring/TransportType

The value for the TransportType settings can be any of the following:

Follow the link for each transport for additional information on configuration options for that transport lower on this page.

Azure Service Bus

Topic-per-event topology for integration events

Starting from version 6.4.0, ServiceControl runs Azure Service Bus transport that, by default, uses topic-per-event topology, as opposed to previously used single-topic topology. This breaking change affects the publishing of integration events.

In order to continue using the single-topic topology, the topic name has to be specified explicitly using the TopicName=<topic-bundle-name> connection string option.

The new topology uses the event type's full name as the name of the topic to which an event is published e.g. servicecontrol.contracts.messagefailed. This mapping can be customized by providing the topology description in JSON using ServiceControl.Transport.ASBS/Topology application setting or ServiceControl_Transport_ASBS_Topology environment variable.

Furthermore, in addition to the connection string options of the transport the following ServiceControl specific options are available in versions 4.4 and above:

• TransportType=AmqpWebSockets - Configures the transport to use AMQP over websockets.
• TopicName=<topic-bundle-name> - Specifies the topic name to be used by the instance. The default value is bundle-1.
• QueueLengthQueryDelayInterval=<value_in_milliseconds> - Specifies the delay between queue length refresh queries for queue length monitoring. The default value is 500 ms.

Enabling Managed Identity

As of version 4.21.8 of ServiceControl, the following options can be used to enable Managed Identity authentication:

• Setting the connection string to a fully-qualified namespace (eg. my-namespace.servicebus.windows.net)
  • With this setting, a DefaultAzureCredential will be used.
  • No connection string options can be used when using a fully-qualified namespace.
• Specifying the connection string option Authentication=Managed Identity
  • The fully-qualified namespace will be parsed from the Endpoint=sb://my-namespace.servicebus.windows.net/ connection string option
  • When specifying managed identity for the connection string, a ManagedIdentityCredential will be used.
  • Set the ClientId=some-client-id connectionstring option to use a specific user-assigned identity

Enabling Partitioned Entities

As of versions 4.33.3 and 5.0.5 of ServiceControl, support for partitioned entities can be enabled by adding the following connection string parameter:

• EnablePartitioning=<True|False> — Configures the transport to create entities that support partitioning. The default value is false.

Example connection string

Endpoint=sb://[namespace].servicebus.windows.net; SharedSecretIssuer=<owner>;SharedSecretValue=<someSecret>;QueueLengthQueryDelayInterval=<IntervalInMilliseconds(Default=500ms)>;TopicName=<TopicBundleName(Default=bundle-1)>;EnablePartitioning=<true|false(Default=false)>

Azure Storage Queues

ServiceControl does not add any connection settings beyond the Azure Storage connection string.

Example connection string

DefaultEndpointsProtocol=[http|https];AccountName=<MyAccountName>;AccountKey=<MyAccountKey>;Subscriptions Table=tablename

RabbitMQ

RabbitMQ contains different TransportType options based on the topology and queue type used by the system:

In addition to the connection string options of the transport, the following options are available in versions 4.4 and above:

• UseExternalAuthMechanism=true|false(default) - Specifies that an external authentication mechanism should be used for client authentication.
• DisableRemoteCertificateValidation=true|false(default) - Allows ServiceControl to connect to the broker even if the remote server certificate is invalid.

These options are available in version 6.5 and above:

• ManagementApiUrl=<SCHEME://HOST:PORT> - The URL of the RabbitMQ management API. If this option is not set, the transport will attempt to automatically generate the URL based on the broker connection string.
• ManagementApiUserName=<USERNAME> - The username used to connect to the RabbitMQ management API. If this option is not set, the credentials from the broker connection string will be used.
• ManagementApiPassword=<PASSWORD> - The password used to connect to the RabbitMQ management API. If this option is not set, the credentials from the broker connection string will be used.
• ValidateDeliveryLimits=<true(default)|false> - Controls the delivery limit validation of the ServiceControl queues.

Example connection string

host=<HOSTNAME>;username=<USERNAME>;password=<PASSWORD>;DisableRemoteCertificateValidation=<true|false(default)>;UseExternalAuthMechanism=<true|false(default)>;ValidateDeliveryLimits=<true(default)|false>;ManagementApiUrl=<SCHEME://HOST:PORT>;ManagementApiUserName=<USERNAME>;ManagementApiPassword=<PASSWORD>

SQL

In addition to the connection string options of the transport the following ServiceControl specific options are available in versions 4.4 and above:

• Queue Schema=<schema_name> - Specifies custom schema for the ServiceControl input queue.
• Subscriptions Table=<subscription_table_name> - Specifies SQL subscription table name.
  • Optional Subscriptions Table=<subscription_table_name>@<schema> - to specify the schema.
  • Optional Subscriptions Table=<subscription_table_name>@<schema>@<catalog> - to specify the schema and catalog.

Example connection string

Data Source=<SQLInstance>;Initial Catalog=nservicebus;Integrated Security=True;Queue Schema=myschema;Subscriptions Table=tablename@schema@catalog

PostgreSQL

In addition to the connection string options of the transport the following ServiceControl specific options are available in versions 5.10 and above:

• Queue Schema=<schema_name> - Specifies a custom schema for the ServiceControl input queue.
• Subscriptions Table=<subscription_table_name> - Specifies PostgreSQL subscription table name.
  • Optional Subscriptions Table=schema.tablename - to specify the schema with simple table name.
  • Optional Subscriptions Table=schema.multi.table.name - to specify the schema with a table name containing ..
  • Optional Subscriptions Table=="multi.table.name=" - to specify a table name containing . without a schema. In this case, Queue Schema will be used if specified, otherwise the default schema (public) will be used.

Example connection string

Server=<ServerName>;Database=nservicebus;Port=5432;User Id=<Username>;Password=<Password>;Queue Schema=myschema;Subscriptions Table=schema.tablename

Amazon SQS

The following ServiceControl connection string options are available:

• AccessKeyId=<value> - AssessKeyId value,
• SecretAccessKey=<value> - SecretAccessKey value,
• Region=<value> - Region transport option,
• QueueNamePrefix=<value> - Queue name prefix transport option,
• TopicNamePrefix=<value> - Topic name prefix transport option
• S3BucketForLargeMessages=<value> - S3 bucket for large messages option,
• S3KeyPrefix=<value> - S3 key prefix option.
• DoNotWrapOutgoingMessages=true - Do not wrap outgoing messages option.
• ReservedBytesInMessageSize=<value> - Available from 7.3 - Reserve bytes in message size calculation option.

Example connection string

Region=<REGION>;QueueNamePrefix=<prefix>;TopicNamePrefix=<prefix>;AccessKeyId=<ACCESSKEYID>;SecretAccessKey=<SECRETACCESSKEY>;S3BucketForLargeMessages=<BUCKETNAME>;S3KeyPrefix=<KEYPREFIX>

MSMQ

To configure MSMQ as the transport, ensure the MSMQ service has been installed and configured as outlined in MSMQ configuration.