Akka.HealthCheck.Hosting.Web
1.5.12
Prefix Reserved
See the version list below for details.
dotnet add package Akka.HealthCheck.Hosting.Web --version 1.5.12
NuGet\Install-Package Akka.HealthCheck.Hosting.Web -Version 1.5.12
<PackageReference Include="Akka.HealthCheck.Hosting.Web" Version="1.5.12" />
paket add Akka.HealthCheck.Hosting.Web --version 1.5.12
#r "nuget: Akka.HealthCheck.Hosting.Web, 1.5.12"
// Install Akka.HealthCheck.Hosting.Web as a Cake Addin #addin nuget:?package=Akka.HealthCheck.Hosting.Web&version=1.5.12 // Install Akka.HealthCheck.Hosting.Web as a Cake Tool #tool nuget:?package=Akka.HealthCheck.Hosting.Web&version=1.5.12
Akka.HealthCheck.Hosting.Web
This package integrates Akka.HealthCheck
, Akka.Hosting
, and Microsoft.AspNetCore.Diagnostics.HealthChecks
, allowing users to access Akka.HealthCheck
via HTTP REST API.
Available Akka.NET Probes
The package provides 5 IHealthCheck
probes that can be registered with the health check middleware, each uniquely tagged so they can be individually filtered during mapping:
AkkaReadinessProbe
- The default readiness probe. The probe reports the time theActorSystem
was started.Tags: [ "akka", "ready", "node" ]
AkkaLivenessProbe
- The default liveness probe. The probe reports the time theActorSystem
was started.Tags: [ "akka", "live", "node" ]
AkkaClusterReadinessProbe
- Readiness probe for clustering.- Reports healthy when:
- The
ActorSystem
joined a cluster. - The
ActorSystem
is connected to a cluster
- The
- Reports unhealthy when:
- The
ActorSystem
just started has not joined a cluster. - All other nodes in the cluster is unreachable.
- The
Tags: [ "akka", "ready", "cluster" ]
- Reports healthy when:
AkkaClusterLivenessProbe
- Liveness probe for clustering.- Reports healthy when:
- The
ActorSystem
joined a cluster. - The
ActorSystem
is connected to a cluster
- The
- Reports unhealthy when:
- The
ActorSystem
just started and has not joined a cluster. - The
ActorSystem
left the cluster.
- The
Tags: [ "akka", "live", "cluster" ]
- Reports healthy when:
AkkaPersistenceLivenessProbe
- Liveness probe for persistence. It probes the persistence storage every second to check that persistence is working properly.- Reports healthy when persistence successfully recover both journal and snapshot data from storage.
- Reports unhealthy when:
- Persistence just started and has not recovered.
- Either journal or snapshot failed recovery inside the periodic check.
Tags: [ "akka", "live", "persistence" ]
Installation
There are 3 steps that needs to be done to integrate Akka.HealthCheck
with diagnostic health check
- Register health check probes to the health check middleware service.
- Add
Akka.HealthCheck
to theActorSystem
. - Map the health check probe routes.
Register Akka.HealthCheck
Services With HealthCheck
The convenience IServiceCollection
extension method WithAkkaHealthCheck(HealthCheckType)
can be used to register the standard probes in any combination.
var webBuilder = WebApplication.CreateBuilder(args);
webBuilder.Services
.WithAkkaHealthCheck(HealthCheckType.All);
As alternative, individual probes can be registered using these methods:
WithAkkaLivenessProbe()
WithAkkaReadinessProbe()
WithAkkaClusterLivenessProbe()
WithAkkaClusterReadinessProbe()
WithAkkaPersistenceLivenessProbe()
Add Akka.HealthCheck
To The ActorSystem
The convenience AkkaConfigurationBuilder
extension method WithWebHealthCheck(IServiceProvider)
automatically scans for any registered probes inside the health check middleware and adds the respective Akka.NET health check probes to the ActorSystem
var webBuilder = WebApplication.CreateBuilder(args);
webBuilder.Services
.WithAkkaHealthCheck(HealthCheckType.All)
.AddAkka("actor-system", (builder, serviceProvider) =>
{
// Automatically detects which health checks were registered
// inside the health check middleware and starts them
builder.WithWebHealthCheck(serviceProvider);
});
Map The Health Check Probe Routes
The convenience IEndpointRouteBuilder
extension method MapAkkaHealthCheckRoutes
automatically scans for any registered probes inside the health check middleware and maps all the probes to a HTTP route. The HTTP route is the concatenation of the probe tags. By default:
AkkaReadinessProbe
is mapped to "/{prefix}/akka/ready/node"AkkaLivenessProbe
is mapped to "/{prefix}/akka/live/node"AkkaClusterReadinessProbe
is mapped to "/{prefix}/akka/ready/cluster"AkkaClusterLivenessProbe
is mapped to "/{prefix}/akka/live/cluster"AkkaPersistenceLivenessProbe
is mapped to "/{prefix}/akka/live/persistence"- All liveness probes can be queried all at once at "/{prefix}/akka/live"
- All readiness probes can be queried all at once at "/{prefix}/akka/ready"
- All Akka.NET probes can be queried all at once at ""/{prefix}/akka"
var webBuilder = WebApplication.CreateBuilder(args);
webBuilder.Services
// Register all of the health check service with IServiceCollection
.WithAkkaHealthCheck(HealthCheckType.All)
.AddAkka("actor-system", (builder, serviceProvider) =>
{
builder
// Automatically detects which health checks were registered
// inside the health check middleware and starts them
.WithWebHealthCheck(serviceProvider);
});
var app = webBuilder.Build();
// Automatically detects which health checks were registered inside
// the health check middleware and maps their routes
app.MapAkkaHealthCheckRoutes();
await app.RunAsync();
HTTP Response
By default, the health check middleware outputs a simple string response of either "healthy" or "unhealthy" regardless of the number of probes being queried. To more verbose response can be gained by using Helper.JsonResponseWriter
as the route endpoint response writer.
app.MapAkkaHealthCheckRoutes(
optionConfigure: opt =>
{
// Use a custom response writer to output a json of all reported statuses
opt.ResponseWriter = Helper.JsonResponseWriter;
});
Example output when all probes are enabled:
{
"status": "Healthy",
"results": {
"akka-liveness": {
"status": "Healthy",
"description": "Akka.NET node is alive",
"data": {
"message": "Live: 12/16/2022 9:54:28 PM +00:00"
}
},
"akka-readiness": {
"status": "Healthy",
"description": "Akka.NET node is ready",
"data": {
"message": "Live: 12/16/2022 9:54:28 PM +00:00"
}
},
"akka-cluster-liveness": {
"status": "Healthy",
"description": "Akka.NET cluster is alive",
"data": {
"message": ""
}
},
"akka-cluster-readiness": {
"status": "Healthy",
"description": "Akka.NET cluster is ready",
"data": {
"message": ""
}
},
"akka-persistence-liveness": {
"status": "Healthy",
"description": "Akka.NET persistence is alive",
"data": {
"message": "RecoveryStatus(JournalRecovered=True, SnapshotRecovered=True)"
}
}
}
}
Manually Setup Custom Akka.NET IProbeProvider
With Health Check Middleware
To manually setup a custom IProbeProvider
, check the custom probe example project.
Documentation on how to set up ASP.NET Core health check can be read here
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 | netcoreapp3.1 is compatible. |
-
.NETCoreApp 3.1
- Akka.HealthCheck.Hosting (>= 1.5.12)
-
net6.0
- Akka.HealthCheck.Hosting (>= 1.5.12)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.5.31 | 1,703 | 11/27/2024 |
1.5.26.1 | 44,233 | 7/18/2024 |
1.5.26 | 721 | 7/15/2024 |
1.5.24 | 6,760 | 6/11/2024 |
1.5.18 | 15,941 | 3/25/2024 |
1.5.17.1 | 2,774 | 3/4/2024 |
1.5.16 | 2,917 | 2/23/2024 |
1.5.12 | 25,780 | 9/11/2023 |
1.5.9 | 4,201 | 7/24/2023 |
1.5.2 | 20,301 | 4/19/2023 |
1.5.0.1 | 5,320 | 3/8/2023 |
1.5.0 | 340 | 3/3/2023 |
1.0.0 | 1,198 | 1/18/2023 |
1.0.0-beta1 | 397 | 1/5/2023 |
[Bump Akka version to 1.5.12](https://github.com/akkadotnet/akka.net/releases/tag/1.5.12)
[Bump Akka.Hosting to 1.5.12.1](https://github.com/akkadotnet/Akka.Hosting/releases/tag/1.5.12.1)
[Hosting: Add options property to configure persistence probe interval](https://github.com/petabridge/akkadotnet-healthcheck/pull/249)
[Fix persistence probe bug where it would go into infinite loop when the snapshot store circuit breaker trips](https://github.com/petabridge/akkadotnet-healthcheck/pull/250)