WebApi.HealthChecks 1.3.0

WebApi.HealthChecks

WebApi.HealthChecks offers a WebApi implementation of the health check endpoints for reporting the health of app infrastructure components.

The package is available on GitHub: https://github.com/kpol/WebApi.HealthChecks

Health checks are exposed by an app as HTTP endpoints. Supports two endpoints:

• /health
• /health/ui?check={check-name}

In the sample app, the health check endpoint is created at /health

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();

        config
            .AddHealthChecks()
            .AddCheck("check1", new HealthyCheck())
            .AddCheck("check2", new UnhealthyCheck())
            .AddCheck("check3", new ExceptionHealthCheck())
            .AddCheck("check5", new DegradedHealthCheck());
    }
}

Every health check must implement IHealthCheck interface

public interface IHealthCheck
{
    Task<HealthCheckResult> CheckHealthAsync();
}

The framework supports three statuses: Unhealthy , Degraded and Healthy.

GET /health returns json in the following format:

{
  "status": "Unhealthy",
  "totalResponseTime": 0,
  "entries": {
    "check1": {
      "responseTime": 0,
      "status": "Healthy"
    },
    "check2": {
      "responseTime": 0,
      "status": "Unhealthy"
    },
    "check3": {
      "status": "Unhealthy"
    },
    "check5": {
      "responseTime": 0,
      "status": "Degraded"
    }
  }
}

The /health/ui?check={check-name} endpoint returns a SVG badge which shows individual status of the service component. For example /health/ui?check=check1 will output this image: