NetEvolve.HealthChecks.RabbitMQ 4.12.3

NetEvolve.HealthChecks.RabbitMQ

This package provides a health check for RabbitMQ, based on the RabbitMQ.Client package. The main purpose is to check that the RabbitMQ service is reachable and that the client can connect to it.

💡 This package is available for .NET 8.0 and later.

Installation

To use this package, you need to add the package to your project. You can do this by using the NuGet package manager or by using the dotnet CLI.

dotnet add package NetEvolve.HealthChecks.RabbitMQ

Health Check - RabbitMQ Service Availability

The health check is a liveness check. It will check that the RabbitMQ service is reachable and that the client can connect to it. If the service needs longer than the configured timeout to respond, the health check will return Degraded. If the service is not reachable, the health check will return Unhealthy.

Usage

After adding the package, you need to import the namespace NetEvolve.HealthChecks.RabbitMQ and add the health check to the service collection.

using NetEvolve.HealthChecks.RabbitMQ;

Therefore, you can use two different approaches. In both approaches you have to provide a name for the health check.

Parameters

• name: The name of the health check. The name is used to identify the configuration object. It is required and must be unique within the application.
• options: The configuration options for the health check. If you don't provide any options, the health check will use the configuration based approach.
• tags: The tags for the health check. The tags rabbitmq and messaging are always used as default and combined with the user input. You can provide additional tags to group or filter the health checks.

Variant 1: Configuration based

The first one is to use the configuration based approach. Therefore, you have to add the configuration section HealthChecks:RabbitMQ to your appsettings.json file.

var builder = services.AddHealthChecks();

builder.AddRabbitMQ("<name>");

The configuration looks like this:

{
    ..., // other configuration
    "HealthChecks": {
        "RabbitMQ": {
            "<name>": {
                "KeyedService": "<name>", // optional, must be given if you want to access a keyed service
                ..., // other configuration
                "Timeout": "<timeout>" // optional, default is 100 milliseconds
            }
        }
    }
}

Variant 2: Options based

The second one is to use the options based approach. Therefore, you have to create an instance of RabbitMQOptions and provide the configuration.

var builder = services.AddHealthChecks();

builder.AddRabbitMQ("<name>", options =>
{
        options.KeyedService = "<name>"; // optional, must be given if you want to access a keyed service
        ...
        options.Timeout = "<timeout>";
});

💡 You can always provide tags to all health checks, for grouping or filtering.

var builder = services.AddHealthChecks();

builder.AddRabbitMQ("<name>", options => ..., "rabbitmq");