Dinaup.HealthCheck 1.0.1

Dinaup.HealthCheck

A lightweight health check library for ASP.NET Core and Blazor Server applications. Provides detailed system metrics, memory information, runtime details, and optional Blazor circuit tracking.

Features

• System metrics (uptime, hostname, version)
• Memory usage (working set, GC heap, collection counts)
• Runtime information (.NET version, OS, CPU count)
• Integration with ASP.NET Core Health Checks
• Optional Blazor Server circuit tracking
• Simple configuration

Installation

dotnet add package Dinaup.HealthCheck

Quick Start

ASP.NET Core / Blazor WebAssembly

// Program.cs
using Dinaup.HealthCheck.Extensions;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDinaupHealthCheck();

var app = builder.Build();

app.MapControllers();

app.Run();

Blazor Server (with circuit tracking)

// Program.cs
using Dinaup.HealthCheck.Extensions;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDinaupHealthCheck(options =>
{
    options.EnableCircuitTracking = true;
});

var app = builder.Build();

app.MapControllers();

app.Run();

Configuration Options

builder.Services.AddDinaupHealthCheck(options =>
{
    // Custom version string (defaults to entry assembly version)
    options.Version = "2.0.0.0";

    // Enable Blazor Server circuit tracking (default: false)
    options.EnableCircuitTracking = true;

    // Custom route (default: "/dinaupHealthCheck")
    options.Route = "/health";
});

Endpoint

Once configured, the health check endpoint is available at:

GET /dinaupHealthCheck

Response Example

{
  "version": "1.2.3.0",
  "environment": "Production",
  "hostname": "dinaup-web-01",
  "uptime": "3.14:22:05",
  "startedAt": "2025-01-11T08:30:00Z",
  "activeCircuits": 42,
  "memory": {
    "workingSetMb": 512,
    "gcHeapMb": 380,
    "gen0Collections": 150,
    "gen1Collections": 42,
    "gen2Collections": 5
  },
  "runtime": {
    "dotnetVersion": "9.0.0",
    "os": "Linux 6.1.0",
    "cpuCount": 4
  },
  "health": {
    "status": "Healthy",
    "totalDurationMs": 45.2,
    "checks": [
      {
        "name": "database",
        "status": "Healthy",
        "durationMs": 12.5,
        "description": "Database connection is healthy"
      },
      {
        "name": "redis",
        "status": "Healthy",
        "durationMs": 3.2
      }
    ]
  }
}

Note: The activeCircuits field is only included when EnableCircuitTracking is set to true.

Integration with ASP.NET Core Health Checks

The library automatically integrates with any registered ASP.NET Core health checks:

// Add your health checks
builder.Services.AddHealthChecks()
    .AddDbContextCheck<MyDbContext>("database")
    .AddRedis("redis-connection-string", name: "redis");

// Add Dinaup Health Check (will include all registered health checks)
builder.Services.AddDinaupHealthCheck();

Response Fields

HTTP Status Codes

• 200 OK - All health checks passed (status is "Healthy")
• 503 Service Unavailable - One or more health checks failed (status is "Degraded" or "Unhealthy")

License

MIT