AspNetCore.HealthChecks.Rabbitmq
8.0.2
dotnet add package AspNetCore.HealthChecks.Rabbitmq --version 8.0.2
NuGet\Install-Package AspNetCore.HealthChecks.Rabbitmq -Version 8.0.2
<PackageReference Include="AspNetCore.HealthChecks.Rabbitmq" Version="8.0.2" />
paket add AspNetCore.HealthChecks.Rabbitmq --version 8.0.2
#r "nuget: AspNetCore.HealthChecks.Rabbitmq, 8.0.2"
// Install AspNetCore.HealthChecks.Rabbitmq as a Cake Addin #addin nuget:?package=AspNetCore.HealthChecks.Rabbitmq&version=8.0.2 // Install AspNetCore.HealthChecks.Rabbitmq as a Cake Tool #tool nuget:?package=AspNetCore.HealthChecks.Rabbitmq&version=8.0.2
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.
Basic
This will create a new IConnection
and reuse on every request to get the health check result. Use
the extension method where you provide the Uri
to connect with. You can optionally set the SslOption
if needed.
IConnection created with this option use UseBackgroundThreadsForIO by default in order to gracefully shutdown on non reference IConnection by ServiceCollection.
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddRabbitMQ(rabbitConnectionString: "amqps://user:pass@host1/vhost")
.AddRabbitMQ(rabbitConnectionString: "amqps://user:pass@host2/vhost");
}
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.
If you are sharing a single connection for every time a health check is requested, you must ensure automatic recovery is enable so that the connection can be re-established if lost.
public void ConfigureServices(IServiceCollection services)
{
services
.AddSingleton<IConnection>(sp =>
{
var factory = new ConnectionFactory
{
Uri = new Uri("amqps://user:pass@host/vhost"),
AutomaticRecoveryEnabled = true
};
return factory.CreateConnection();
})
.AddHealthChecks()
.AddRabbitMQ();
}
Alternatively, you can specify the connection to use with a factory function given the IServiceProvider
.
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddRabbitMQ(sp =>
{
var factory = new ConnectionFactory
{
Uri = new Uri("amqps://user:pass@host/vhost"),
AutomaticRecoveryEnabled = true
};
return factory.CreateConnection();
});
}
Or you register IConnectionFactory and then the healthcheck will create a single connection for that one.
public void ConfigureServices(IServiceCollection services)
{
services
.AddSingleton<IConnectionFactory>(sp =>
new ConnectionFactory
{
Uri = new Uri("amqps://user:pass@host/vhost"),
AutomaticRecoveryEnabled = true
})
.AddHealthChecks()
.AddRabbitMQ();
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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 was computed. 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.0)
- RabbitMQ.Client (>= 6.8.1)
-
net6.0
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)
- RabbitMQ.Client (>= 6.8.1)
NuGet packages (69)
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 |
|
Reo.Core.Elastic
Package Description |
|
Reo.Core.Elastic.Geo
Package Description |
|
Reo.Core.Email
Package Description |
GitHub repositories (17)
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 8, DDD, CQRS, Event Sourcing, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
Version | Downloads | Last updated |
---|---|---|
8.0.2 | 299,949 | 9/3/2024 |
8.0.1 | 1,307,173 | 4/2/2024 |
8.0.0 | 1,084,512 | 12/15/2023 |
7.0.0 | 1,068,686 | 7/30/2023 |
7.0.0-rc2.7 | 62,586 | 3/13/2023 |
7.0.0-rc2.6 | 14,433 | 1/14/2023 |
7.0.0-rc2.5 | 14,096 | 12/27/2022 |
7.0.0-rc2.4 | 192 | 12/27/2022 |
6.0.2 | 11,154,429 | 2/28/2022 |
6.0.1 | 1,173,142 | 12/29/2021 |
6.0.1-rc2.3 | 45,496 | 11/10/2021 |
6.0.1-rc1.1 | 950 | 11/5/2021 |
6.0.0 | 57,458 | 12/29/2021 |
5.0.2 | 989,053 | 11/4/2021 |
5.0.1 | 2,106,060 | 1/5/2021 |
5.0.0 | 74,647 | 12/29/2020 |
5.0.0-preview1 | 7,844 | 11/22/2020 |
3.1.4 | 2,985,592 | 7/22/2020 |
3.1.3 | 76,487 | 7/22/2020 |
3.1.2 | 545,977 | 6/3/2020 |
3.1.1 | 521,613 | 4/17/2020 |
3.1.0 | 59,996 | 4/9/2020 |
3.0.7 | 91,498 | 4/1/2020 |
3.0.6 | 1,473 | 3/31/2020 |
3.0.5 | 376,252 | 2/11/2020 |
3.0.4 | 239,233 | 1/20/2020 |
3.0.3 | 397,224 | 12/5/2019 |
3.0.2 | 7,738 | 12/2/2019 |
3.0.1 | 70,247 | 10/30/2019 |
3.0.0 | 125,495 | 9/24/2019 |
2.2.1 | 2,082,267 | 2/25/2019 |
2.2.0 | 635,812 | 11/14/2018 |