Voyager.HealthEndpoint.HealthChecks 2.0.0

Voyager.HealthEndpoint.HealthChecks

Adapter that bridges Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService to the IAppStatus contract from Voyager.HealthEndpoint.

A single MapVoyHealth() endpoint can aggregate any number of IHealthCheck instances registered via services.AddHealthChecks() — including the full ecosystem of xabaril AspNetCore.HealthChecks.* checks for databases, queues, and external services.

Install

dotnet add package Voyager.HealthEndpoint.HealthChecks

This package depends on Voyager.HealthEndpoint; you do not install both separately.

Quick start

using Microsoft.Extensions.Diagnostics.HealthChecks;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthServices()
                .UseHealthCheckService(options =>
                {
                    options.StoreName = "identity-service";
                    // Scope the readiness probe to checks tagged "ready". Liveness ignores them.
                    options.Predicate = registration => registration.Tags.Contains("ready");
                });

builder.Services.AddHealthChecks()
                .AddNpgSql(connectionString, tags: new[] { "ready" })
                .AddCheck<OpenIddictKeysCheck>("openiddict_keys", tags: new[] { "ready" })
                .AddCheck("self", () => HealthCheckResult.Healthy(), tags: new[] { "live" });

var app = builder.Build();
app.MapVoyHealth();   // /health, /health/readiness, /sqlname unchanged
app.Run();

Mapping rules

The Predicate you set on HealthCheckServiceAppStatusOptions flows directly to HealthCheckService.CheckHealthAsync(predicate). Tag your checks "ready" or "live" at registration to pre-segment them, then point the readiness endpoint at one slice and let the liveness endpoint stay independent.

How it differs from the core package

Voyager.HealthEndpoint alone gives you the three endpoints (/health, /health/readiness, /sqlname) and a single IAppStatus.ReadAsync() you implement once per service. The HealthChecks adapter swaps that custom IAppStatus for one that delegates to HealthCheckService, so you compose readiness from N small IHealthChecks instead of writing one big ReadAsync. Pick this package when:

• You already use (or want to use) the xabaril AspNetCore.HealthChecks.* ecosystem.
• You want tag-based separation between liveness and readiness without writing two IAppStatus implementations.
• You want JSON HealthReport semantics under the hood (Degraded, descriptions, per-check timings) while keeping the simple plain-text endpoint contract for K8s.

Links

• Source, issue tracker, full README, and migration notes: github.com/Voyager-Poland/Voyager.HealthEndpoint
• Runnable sample: samples/HealthChecksAdapter
• Kubernetes deployment with probes wired: samples/KubernetesExample
• Changelog: CHANGELOG.md
• License: MIT