Install Custom Checks Plugin

Component: ServiceControl CustomChecks
NuGet Package NServiceBus.CustomChecks (2.x)
Target NServiceBus Version: 6.x

To install the Custom Checks plugin into an endpoint add the following to the endpoint configuration:

var endpointConfiguration = new EndpointConfiguration("MyEndpoint");
endpointConfiguration.ReportCustomChecksTo(
    serviceControlQueue: "ServiceControl_Queue",
    timeToLive: TimeSpan.FromSeconds(10));

It may not make sense to enable the custom checks plugin in all environments. For instance, a development environment may not have a running ServiceControl instance to consume custom check messages. In these cases, enable the plugin conditionally, based on an environment variable or configuration setting.

The timeToLive (TTL) parameter is optional and defaults to four times the interval for periodic checks or infinite for one-time checks. Some queue systems (e.g. MSMQ) handle TTL proactively by removing timed out messages from the queues. Others do it only when a message is about to be received. Running the CustomChecks without ServiceControl installed may cause the destination queue to grow infinitely and consume all available system resources.


Last modified