Akka.HealthCheck.Hosting 1.0.0-beta1

Prefix Reserved
This is a prerelease version of Akka.HealthCheck.Hosting.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Akka.HealthCheck.Hosting --version 1.0.0-beta1                
NuGet\Install-Package Akka.HealthCheck.Hosting -Version 1.0.0-beta1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Akka.HealthCheck.Hosting" Version="1.0.0-beta1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Akka.HealthCheck.Hosting --version 1.0.0-beta1                
#r "nuget: Akka.HealthCheck.Hosting, 1.0.0-beta1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Akka.HealthCheck.Hosting as a Cake Addin
#addin nuget:?package=Akka.HealthCheck.Hosting&version=1.0.0-beta1&prerelease

// Install Akka.HealthCheck.Hosting as a Cake Tool
#tool nuget:?package=Akka.HealthCheck.Hosting&version=1.0.0-beta1&prerelease                

Package Description

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Akka.HealthCheck.Hosting:

Package Downloads
Akka.HealthCheck.Hosting.Web

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.26.1 362 7/18/2024
1.5.26 448 7/15/2024
1.5.24 4,791 6/11/2024
1.5.18 13,283 3/25/2024
1.5.17.1 3,293 3/4/2024
1.5.16 2,498 2/23/2024
1.5.12 31,291 9/11/2023
1.5.9 5,811 7/24/2023
1.5.2 21,291 4/19/2023
1.5.0.1 5,322 3/8/2023
1.5.0 645 3/3/2023
1.0.0 1,564 1/18/2023
1.0.0-beta1 433 1/5/2023

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)