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

Artemis Health Check

This health check verifies the ability to connect to an Apache ActiveMQ Artemis broker using Apache.NMS.AMQP.

Example Usage

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddArtemis("amqp://localhost:61616");
}

For authenticated brokers:

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddArtemis(
            "amqp://localhost:61616",
            options =>
            {
                options.UserName = "artemis";
                options.Password = "artemis";
                options.RequestTimeout = TimeSpan.FromSeconds(5);
            });
}

If the application already owns the IConnectionFactory, register it and let the health check resolve it:

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddSingleton<IConnectionFactory>(new Apache.NMS.AMQP.ConnectionFactory("amqp://localhost:61616"))
        .AddHealthChecks()
        .AddArtemis();
}

Like all IHealthChecksBuilder extensions, the following parameters may be overridden:

• name: The health check name. Default is artemis.
• failureStatus: The HealthStatus that should be reported when the health check fails. Default is HealthStatus.Unhealthy.
• tags: A list of tags that can be used to filter sets of health checks.
• timeout: A System.TimeSpan representing the timeout of the check.

<<