Part of Anarchy I/O Toolkit, a .NET developer platform · Pillar: Infrastructure · Layer: Core · Package catalog

Shared health-check contracts and report models for service endpoints.

dotnet add package Anarchy.Toolkit.Core.Health
  • Implement IHealthCheck or derive from HealthCheckBase for timed, exception-safe checks.
  • Use HealthCheckReport.RunAsync(reports) to run reports in parallel and aggregate their results.
  • HealthCheckOutcome, ExceptionReport, IBuildMetadata and ApplicationRunbookUriAttribute provide shared health and status metadata.

When to use it

Use this package to describe dependency checks independently of the HTTP host. It is suitable for checks such as a database ping or a downstream service probe; the web and worker packages can expose the results using the same model.

How to use it

Implement a report for each dependency. Return normally for a passing check and throw on failure; the base class records the duration and converts exceptions into failed results. Caller-requested cancellation is propagated.

using Anarchy.Toolkit.Core.Health.Checks;

public sealed class ExampleHealthReport : HealthCheckBase
{
    protected override string Name => "example_dependency";

    protected override async Task CheckAsync(CancellationToken cancellationToken)
    {
        // Replace with a real, bounded dependency check.
        await Task.Delay(1, cancellationToken);
    }
}

Supply reports as an IReadOnlyCollection<IHealthCheck> to the toolkit’s web or worker health endpoints, or call HealthCheckReport.RunAsync(reports) to aggregate them directly. A successful placeholder check does not establish that a real dependency is healthy.

The Web and Hosting.Workers packages expose health endpoints. See the toolkit overview.

Releases

See the release notes for the complete release history.