Orneholm.ApplicationInsights.HealthChecks 0.1.0

Orneholm - Application Insights - Health Checks

ASP.NET Core Health check publisher for Azure Application Insights that will publish the health check reports as availibility telemetry, including details and data. As described in the Microsoft Docs custom availibility telemetry does not show up in all dashboards, but you can easily trigger alerts on them and show data by custom Log Analytics queries.

Install

Orneholm.ApplicationInsights.HealthChecks is distributed as package on NuGet, install using the tool of your choice, for example dotnet cli:

dotnet add package Orneholm.ApplicationInsights.HealthChecks

Getting started

To get started, configure your ASP.NET Core 2.2 app to use Application Insights:

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
            .UseApplicationInsights()
            .UseStartup<Startup>();

Then, in your Startup.cs, where you register your services, add the Application Insights Availability Publisher:

services.AddHealthChecks()
        .AddCheck("SampleCheck1", () => HealthCheckResult.Healthy())
		.AddCheck("SampleCheck2", () => HealthCheckResult.Degraded())
		.AddCheck("SampleCheck3", () => HealthCheckResult.Unhealthy())
        .AddApplicationInsightsAggregatedAvailabilityPublisher()
        .AddApplicationInsightsAvailabilityPublisher();

• .AddApplicationInsightsAggregatedAvailabilityPublisher(): Aggregate all health check reports into one availability telemetry and send it to Application Insights. Only contains general details and details on status, duration and description for each health check.
• .AddApplicationInsightsAvailabilityPublisher(): This will publish each health check report as individual availability telemetry and send it to Application Insights. Contains more details such as data returned from each check.

Both of them can be used side by side, to get one item for the general health of the system and then multiple ones with more details.

Customization

You can customize some options, by using an overload:

.AddApplicationInsightsAggregatedAvailabilityPublisher(options =>
{
    options.TestName = "AspNetHealthChecks";
    options.TestRunLocation = "Application";
    options.TreatDegradedAsSuccess = false;
})
.AddApplicationInsightsAvailabilityPublisher(options =>
{
    options.TestNamePrefix = "AspNetHealthCheck";
    options.TestRunLocation = "Application";
    options.TreatDegradedAsSuccess = false;
});