AspNetCore.HealthChecks.Rabbitmq
9.0.0
dotnet add package AspNetCore.HealthChecks.Rabbitmq --version 9.0.0
NuGet\Install-Package AspNetCore.HealthChecks.Rabbitmq -Version 9.0.0
<PackageReference Include="AspNetCore.HealthChecks.Rabbitmq" Version="9.0.0" />
paket add AspNetCore.HealthChecks.Rabbitmq --version 9.0.0
#r "nuget: AspNetCore.HealthChecks.Rabbitmq, 9.0.0"
// Install AspNetCore.HealthChecks.Rabbitmq as a Cake Addin #addin nuget:?package=AspNetCore.HealthChecks.Rabbitmq&version=9.0.0 // Install AspNetCore.HealthChecks.Rabbitmq as a Cake Tool #tool nuget:?package=AspNetCore.HealthChecks.Rabbitmq&version=9.0.0
RabbitMQ Health Check
This health check verifies the ability to communicate with a RabbitMQ server
Example Usage
With all of the following examples, you can additionally add the following parameters:
name
: The health check name. Default if not specified israbbitmq
.failureStatus
: TheHealthStatus
that should be reported when the health check fails. Default isHealthStatus.Unhealthy
.tags
: A list of tags that can be used to filter sets of health checks.timeout
: ASystem.TimeSpan
representing the timeout of the check.
Dependency Injected IConnection
As per RabbitMQ docs and its suggestions on high connectivity churn, connections are meant to be long lived. Ideally, this should be configured as a singleton. The health check should use the same IConnection instance that is used in the application.
public void ConfigureServices(IServiceCollection services)
{
services
.AddSingleton<IConnection>(sp =>
{
var factory = new ConnectionFactory
{
Uri = new Uri("amqps://user:pass@host/vhost"),
};
return factory.CreateConnectionAsync().GetAwaiter().GetResult();
})
.AddHealthChecks()
.AddRabbitMQ();
}
Caching IConnection outside of Dependency Injection
Alternatively, you can create the connection outside of the dependency injection container and use it in the health check.
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddRabbitMQ(sp => connectionTask.Value);
}
private static readonly Lazy<Task<IConnection>> connectionTask = new Lazy<Task<IConnection>>(CreateConnection);
private static async Task<IConnection> CreateConnection()
{
var factory = new ConnectionFactory
{
Uri = new Uri("amqps://user:pass@host/vhost"),
};
return await factory.CreateConnectionAsync();
}
Breaking changes
RabbitMQHealthCheck
was letting the users specify how IConnection
should be created (from raw connection string or from Uri
or from IConnectionFactory
), at a cost of maintaining an internal, static client instances cache. Now the type does not create client instances nor maintain an internal cache and it's the caller responsibility to provide the instance of IConnection
(please see #2048 for more details). Since RabbitMQ recommends reusing client instances since they can be expensive to create, it's recommended to register a singleton factory method for IConnection
. So the client is created only when needed and once per whole application lifetime.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.11)
- RabbitMQ.Client (>= 7.0.0)
-
net8.0
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.11)
- RabbitMQ.Client (>= 7.0.0)
NuGet packages (65)
Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.Rabbitmq:
Package | Downloads |
---|---|
Reo.Core.Queue.RabbitMq
Package Description |
|
Reo.Core.Queue
Package Description |
|
NanoCore
The project is inspired by years of tedious repetitions, continuously re-writing similar code-snippets and libraries, to handle common functionality, not related to the business domain, such as logging, data persistence, message queuing, documentation, validation and similar. |
|
Oms.Framework
Update page result |
|
EachShow.Host
主机启动程序 |
GitHub repositories (18)
Showing the top 5 popular GitHub repositories that depend on AspNetCore.HealthChecks.Rabbitmq:
Repository | Stars |
---|---|
dotnet/aspire
Tools, templates, and packages to accelerate building observable, production-ready apps
|
|
AlphaYu/adnc
.NET微服务/分布式开发框架,同时也适用于单体架构系统的开发。
|
|
desenvolvedor-io/dev-store
A microservices e-commerce reference application built with ASP.NET 6
|
|
IoTSharp/IoTSharp
IoTSharp is an open-source IoT platform for data collection, processing, visualization, and device management.
|
|
meysamhadeli/booking-microservices
Practical microservices, built with .Net 9, DDD, CQRS, Event Sourcing, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
Version | Downloads | Last updated |
---|---|---|
9.0.0 | 717 | 12/19/2024 |
8.0.2 | 636,902 | 9/3/2024 |
8.0.1 | 1,527,038 | 4/2/2024 |
8.0.0 | 1,194,160 | 12/15/2023 |
7.0.0 | 1,128,746 | 7/30/2023 |
7.0.0-rc2.7 | 63,844 | 3/13/2023 |
7.0.0-rc2.6 | 14,657 | 1/14/2023 |
7.0.0-rc2.5 | 14,107 | 12/27/2022 |
7.0.0-rc2.4 | 199 | 12/27/2022 |
6.0.2 | 11,469,947 | 2/28/2022 |
6.0.1 | 1,183,311 | 12/29/2021 |
6.0.1-rc2.3 | 45,880 | 11/10/2021 |
6.0.1-rc1.1 | 957 | 11/5/2021 |
6.0.0 | 61,424 | 12/29/2021 |
5.0.2 | 999,807 | 11/4/2021 |
5.0.1 | 2,122,593 | 1/5/2021 |
5.0.0 | 77,783 | 12/29/2020 |
5.0.0-preview1 | 7,851 | 11/22/2020 |
3.1.4 | 3,022,916 | 7/22/2020 |
3.1.3 | 76,544 | 7/22/2020 |
3.1.2 | 551,755 | 6/3/2020 |
3.1.1 | 525,383 | 4/17/2020 |
3.1.0 | 60,838 | 4/9/2020 |
3.0.7 | 92,530 | 4/1/2020 |
3.0.6 | 1,494 | 3/31/2020 |
3.0.5 | 378,748 | 2/11/2020 |
3.0.4 | 240,942 | 1/20/2020 |
3.0.3 | 401,277 | 12/5/2019 |
3.0.2 | 7,753 | 12/2/2019 |
3.0.1 | 71,170 | 10/30/2019 |
3.0.0 | 128,727 | 9/24/2019 |
2.2.1 | 2,206,284 | 2/25/2019 |
2.2.0 | 641,499 | 11/14/2018 |