HealthChecks.OpenTelemetry.Instrumentation 1.0.0-dev.7

HealthChecks Instrumentation for OpenTelemetry .NET

This is an Instrumentation Library, which instruments Microsoft.Extensions.Diagnostics.HealthChecks and collect telemetry about the application health checks.

Steps to enable HealthChecks.OpenTelemetry.Instrumentation

Step 1: Install package

Add a reference to the HealthChecks.OpenTelemetry.Instrumentation package.

dotnet add package HealthChecks.OpenTelemetry.Instrumentation

Step 2: Enable HealthChecks Instrumentation

HealthChecks instrumentation should be enabled at application startup using the AddHealthChecksInstrumentation extension on MeterProviderBuilder. The following example demonstrates adding HealthChecks instrumentation to a console application. This example also sets up the OpenTelemetry Console exporter, which requires adding the package OpenTelemetry.Exporter.Console to the application:

using OpenTelemetry;
using OpenTelemetry.Metrics;

public class Program
{
    public static void Main(string[] args)
    {
        using var meterProvider = Sdk.CreateMeterProviderBuilder()
            .AddHealthChecksInstrumentation()
            .AddConsoleExporter()
            .Build();
    }
}

For an ASP.NET Core application, adding instrumentation is typically done in the ConfigureServices of your Startup class. Refer to documentation for OpenTelemetry.Instrumentation.AspNetCore.

Refer to Program.cs for a complete demo.

Advanced configuration

This instrumentation can be configured to change the default behavior by using HealthChecksInstrumentationOptions.

services.AddOpenTelemetry()
    .WithMetrics(builder => builder
        .AddHealthChecksInstrumentation(options =>
        {
            options.StatusGaugeName = "myapp_health";
            options.DurationGaugeName = "myapp_health_duration";
        })
        .AddConsoleExporter());

When used with OpenTelemetry.Extensions.Hosting, all configurations to HealthChecksInstrumentationOptions can be done in the ConfigureServices method of you applications Startup class as shown below.

// Configure
services.Configure<HealthChecksInstrumentationOptions>(options =>
{
    options.StatusGaugeName = "myapp_health";
    options.DurationGaugeName = "myapp_health_duration";
});

services.AddOpenTelemetry()
    .WithMetrics(builder => builder
        .AddHealthChecksInstrumentation()
        .AddConsoleExporter());

Metrics

aspnetcore_healthcheck

Gets the health status of the component that was checked, converted to double value (0 == Unhealthy, 0.5 == Degraded, 1 == Healthy).

The API used to retrieve the value is:

• HealthReportEntry.Status: Gets the health status of the component that was checked.

aspnetcore_healthcheck_duration

Gets the health check execution duration.

The API used to retrieve the value is:

• HealthReportEntry.Duration: Gets the health check execution duration.

References

• OpenTelemetry Project