DotNetDiag HealthChecks

Package reference page maintained from the source documentation in src/HealthChecks.Nats.

NATS Health Check

This health check verifies the ability to communicate with a NATS server.
It relies on NATS.Net package.
Latest tag for the official dockerhub image is 2.6.6.

Builder Extension

public void ConfigureServices(IServiceCollection services)
{
    var options = NatsOpts.Default with
    {
      Url = "nats://demo.nats.io:4222"
    };

    services
        .AddSingleton<INatsConnection>(new NatsConnection(options))
        .AddHealthChecks()
        .AddNats();
}

Url property is NATS server url and is mandatory.
There is a demo instance nats://demo.nats.io:4222 managed by nats.io and this is the default value for the url property.
The rest of the properties in NatsOpts are optional.
Docker image produces nats://localhost:4222.
Url might also be a string containing multiple URLs to the NATS Server, e.g. nats://localhost:4222, nats://localhost:8222.

See NKeys for reference to the PrivateNKey and Jwt properties.

See Authenticating with a Credentials File for details related to the CredentialsPath property.

Like all IHealthChecksBuilder extensions, all the following parameters have type default values and may be overridden:

<<