Philiprehberger.HealthCheckKit 0.3.0

Philiprehberger.HealthCheckKit

Composable health checks for ASP.NET Core with built-in URL, TCP, DNS, certificate, disk, and memory checks.

Installation

dotnet add package Philiprehberger.HealthCheckKit

Usage

using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddUrlCheck("https://api.example.com/health")
    .AddTcpCheck("db-server", 5432)
    .AddDnsCheck("api.example.com")
    .AddCertificateCheck("api.example.com")
    .AddDiskSpaceCheck(minimumFreeBytes: 500_000_000)
    .AddMemoryCheck(maximumBytes: 1_073_741_824));

app.MapHealthChecks("/health");

TCP Port Connectivity

using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddTcpCheck("db-server", 5432)
    .AddTcpCheck("redis", 6379, timeout: TimeSpan.FromSeconds(2)));

DNS Resolution

using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddDnsCheck("api.example.com")
    .AddDnsCheck("storage.example.com"));

SSL Certificate Expiration

using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddCertificateCheck("api.example.com")
    .AddCertificateCheck("payments.example.com", warningDays: 14));

Composite Health Report

using Philiprehberger.HealthCheckKit;

var runner = new HealthCheckKitBuilder()
    .AddUrlCheck("https://api.example.com/health")
    .AddTcpCheck("db-server", 5432)
    .AddDnsCheck("api.example.com")
    .BuildRunner();

var report = await runner.RunAllAsync();

Console.WriteLine($"Status: {report.Status}, Total: {report.TotalElapsed.TotalMilliseconds}ms");

foreach (var entry in report.Entries)
{
    Console.WriteLine($"  {entry.Name}: {entry.Result.Status} ({entry.Duration.TotalMilliseconds}ms)");
}

Built-in Checks

using Philiprehberger.HealthCheckKit;

// URL check — Healthy on 2xx, Degraded on timeout, Unhealthy otherwise
builder.Services.AddHealthCheckKit(checks => checks
    .AddUrlCheck("https://downstream-service.example.com/ping"));

// Disk space check — Unhealthy when free space drops below threshold
builder.Services.AddHealthCheckKit(checks => checks
    .AddDiskSpaceCheck(minimumFreeBytes: 500_000_000));

// Memory check — Unhealthy when managed memory exceeds limit
builder.Services.AddHealthCheckKit(checks => checks
    .AddMemoryCheck(maximumBytes: 1_073_741_824));

Ping and Process Memory

using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddPingCheck("api.example.com")
    .AddProcessMemoryCheck(maximumWorkingSetBytes: 2_147_483_648));

Tagging Checks

Each AddXxxCheck accepts a params string[] tags argument that is surfaced on the report entry:

using Philiprehberger.HealthCheckKit;

var runner = new HealthCheckKitBuilder()
    .AddTcpCheck("db", 5432, tags: new[] { "infra", "critical" })
    .AddUrlCheck("https://api.example.com/health", tags: new[] { "api" })
    .BuildRunner();

runner.PerCheckTimeout = TimeSpan.FromSeconds(10);
var report = await runner.RunAllAsync();

foreach (var entry in report.Entries)
{
    Console.WriteLine($"{entry.Name} [{string.Join(',', entry.Tags)}]: {entry.Result.Status}");
}

Custom Checks

using Microsoft.Extensions.Diagnostics.HealthChecks;
using Philiprehberger.HealthCheckKit;

builder.Services.AddHealthCheckKit(checks => checks
    .AddCustomCheck("database", async cancellationToken =>
    {
        var isHealthy = await CheckDatabaseConnectionAsync(cancellationToken);
        return isHealthy
            ? HealthCheckResult.Healthy("Database is reachable.")
            : HealthCheckResult.Unhealthy("Database is unreachable.");
    }));

API

HealthCheckKitBuilder

HealthCheckRunner

HealthReport

HealthCheckEntry

ServiceCollectionExtensions

TcpHealthCheck

DnsHealthCheck

CertificateHealthCheck

UrlHealthCheck

DiskSpaceHealthCheck

MemoryHealthCheck

Development

dotnet build src/Philiprehberger.HealthCheckKit.csproj --configuration Release

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT