Skip to content

Latest commit

 

History

History
205 lines (155 loc) · 10.2 KB

RELEASE_NOTES.md

File metadata and controls

205 lines (155 loc) · 10.2 KB
Raw

1.5.26.1 July 18 2024

1.5.26 July 16 2024

1.5.24 June 11 2024

1.5.18 March 25 2024

1.5.17.1 March 4 2024

1.5.16 February 23 2024

1.5.12 September 11 2023

1.5.9 July 25 2023

1.5.2 April 19 2023

1.5.0.1 March 8 2023

Version 1.5.0.1 contains a patch that fixes Akka.HealthCheck.Persistence database problems.

1.5.0 March 3 2023

Version 1.5.0 integrates Akka.Management and Akka.NET v1.5.0 RTM.

1.0.0 January 18 2023

This version 1.0.0 release is the RTM release for Akka.HealthCheck; the public API will be frozen from this point forward and backed with our backward compatibility promise.

1.0.0-beta1 January 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.

Notable Changes From Previous Versions

NOTE

All these information can be read in the documentation here

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:

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:

// 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:

[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:

// 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:

// 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

0.3.4 December 22 2022

This release is a patch release for a bug in the persistence liveness probe.

0.3.3 November 2 2022

0.3.2 June 24 2021

0.3.1 March 25 2021

Bumped Akka version Bumped Akka version to 1.4.18