Lightweight health checks and readiness probes for .NET services. Built-in checks for databases, HTTP dependencies, disk space, and memory with three-state model, TTL caching, and Kubernetes-ready endpoints.
Get Started
$ dotnet add package JG.HealthKitReadme
dotnet-health-kit
Lightweight health check and readiness probe library for .NET services. Built-in checks for databases, HTTP dependencies, disk space, and memory — with Kubernetes-ready endpoints, degraded state detection, and custom check support.
Features
- Liveness & Readiness — Separate
/health/liveand/health/readyendpoints for orchestrator probes - Built-in Checks — Database connectivity, HTTP dependency, disk space, memory pressure, custom TCP
- Degraded State — Three-state model (Healthy, Degraded, Unhealthy) with configurable thresholds
- Custom Checks — Implement
IHealthCheckfor application-specific health indicators - Caching — Configurable TTL to prevent health check storms under load
- JSON Response — Detailed check results with timing, status, and error context
- Startup Probes — Optional startup check that gates readiness until initialization completes
- Single Registration —
services.AddHealthKit()
Installation
dotnet add package JG.HealthKit
Quick Start
builder.Services.AddHealthKit(options =>
{
options.AddSqlServer("Server=localhost;Database=mydb;...");
options.AddHttpDependency("payment-api", "https://api.payments.com/health");
options.AddDiskSpace(threshold: 500_000_000); // 500MB minimum
options.CacheDuration = TimeSpan.FromSeconds(10);
});
app.MapHealthKit(); // Maps /health/live and /health/ready
Documentation
- API Reference — Full API documentation and examples
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
Licensed under the Apache License 2.0. See LICENSE for details.
Ready to get started? Install via NuGet and check out the API reference.