Akka.HealthCheck.Hosting.Web 1.0.0-beta1

• .NETCoreApp 3.1

  • Akka.HealthCheck.Hosting (>= 1.0.0-beta1)

• net6.0

  • Akka.HealthCheck.Hosting (>= 1.0.0-beta1)

This release is a beta release of the new `Akka.Hosting` API and the ASP.NET integration API. We would love to hear your input on these new APIs.
[Bumped Akka version to 1.4.47](https://github.com/akkadotnet/akka.net/releases/tag/1.4.47)
[Add multi probe provider support](https://github.com/petabridge/akkadotnet-healthcheck/pull/151)
[Add `Akka.Hosting` support and ASP.NET IHealthCheck integration](https://github.com/petabridge/akkadotnet-healthcheck/pull/148)
[Expanded persistence health check reporting](https://github.com/petabridge/akkadotnet-healthcheck/pull/154)
[Bump Akka.Hosting from 0.5.1 to 1.0.0](https://github.com/petabridge/akkadotnet-healthcheck/pull/163)
[Improve ASP.NET health check route configuration callback](https://github.com/petabridge/akkadotnet-healthcheck/pull/165)
[Fix probe status reporting to account for all provider statuses](https://github.com/petabridge/akkadotnet-healthcheck/pull/171)
[Add documentation](https://github.com/petabridge/akkadotnet-healthcheck/pull/173)
Notable Changes From Previous Versions**
> **NOTE**
>
> All these information can be read in the documentation [here](https://github.com/petabridge/akkadotnet-healthcheck/blob/dev/README.md)
1. Improved Persistence Status Report**
Persistence health check now returns a `PersistenceLivenessStatus` with a more comprehensive status report that also includes whether snapshots and journal events were successfully persisted, and any exceptions thrown during the probe execution.
2. Multi-provider Support**
Both liveness and readiness endpoint can now host multiple health check probe providers. Note that both liveness and readiness endpoint will return unhealthy if any of these hosted probes reported that they are unhealthy.
The HOCON configuration for `Akka.HealthCheck` has been changed to accomodate this. Instead of settings a single provider, you can now pass in multiple providers at once:
```hocon
akka.healthcheck {
liveness {
providers {
default = "Akka.HealthCheck.Liveness.DefaultLivenessProvider, Akka.HealthCheck"
cluster = "Akka.HealthCheck.Cluster.ClusterLivenessProbeProvider, Akka.HealthCheck.Cluster"
}
}
readiness {
providers {
default = "Akka.HealthCheck.Readiness.DefaultReadinessProvider, Akka.HealthCheck"
custom = "MyAssembly.CustomReadinessProvider, MyAssembly"
}
}
```
3. `Akka.Hosting` integration**
To configure multi providers via `Akka.Hosting`, you can install the new `Akka.HealthCheck.Hosting` NuGet package and use the convenience method `AddProviders()` and provide the combination of providers you would like to run like so:
```csharp
// Add Akka.HealthCheck
builder.WithHealthCheck(options =>
{
// Here we're adding all of the built-in providers
options.AddProviders(HealthCheckType.All);
});
```
`HealthCheckType` is a bit flag enum that consists of these choices:
```csharp
[Flags]
public enum HealthCheckType
{
DefaultLiveness = 1,
DefaultReadiness = 2,
Default = DefaultLiveness | DefaultReadiness,
ClusterLiveness = 4,
ClusterReadiness = 8,
Cluster = ClusterLiveness | ClusterReadiness,
PersistenceLiveness = 16,
Persistence = PersistenceLiveness,
All = Default | Cluster | Persistence
}
```
Depending on your code style, You can also use the more verbose methods to add providers:
```csharp
// Add Akka.HealthCheck
builder.WithHealthCheck(options =>
{
// Here we're adding all of the built-in providers one provider at a time
options
.ClearAllProviders()
.AddDefaultReadinessProvider()
.AddClusterReadinessProvider()
.AddDefaultLivenessProvider()
.AddClusterLivenessProvider()
.AddPersistenceLivenessProvider();
});
```
Custom `IProbeProvider` can be added using these methods:
```csharp
// Add Akka.HealthCheck
builder.WithHealthCheck(options =>
{
// Adding custom user IProbeProvider providers
options
.AddReadinessProvider<MyReadinessProvider>("custom-readiness")
.AddLivenessProvider<MyLivenessProvider>("custom-liveness");
});
```
4. ASP.NET `IHealthCheck` Integration**
`Akka.HealthCheck` can be integrated directly by installing the `Akka.HealthCheck.Hosting.Web` NuGet package. You can read the documentation [here](https://github.com/petabridge/akkadotnet-healthcheck/blob/dev/README.md#aspnet-integration)