HealthCheckDashboard.NET 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package HealthCheckDashboard.NET --version 1.0.0
                    


                    

                
NuGet\Install-Package HealthCheckDashboard.NET -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="HealthCheckDashboard.NET" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="HealthCheckDashboard.NET" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="HealthCheckDashboard.NET" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add HealthCheckDashboard.NET --version 1.0.0
                    


                    

                
#r "nuget: HealthCheckDashboard.NET, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package HealthCheckDashboard.NET@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=HealthCheckDashboard.NET&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=HealthCheckDashboard.NET&version=1.0.0
                    


                            Install as a Cake Tool

HealthCheckDashboard.NET

A health check dashboard built on top of IHealthCheck.
It works by fetching the health status from each healthcheck through the healthservice (internal to the healthcheck library),
and exposing this as an endpoint.

image

Example


// Add your healthchecks as usual. 
builder.Services.AddHealthChecks()
    .AddCheck<SimpleSuccessHealthCheck>("Simple Success", tags: new[] {"Simple", "Success"})
    .AddCheck<SimpleDegradedHealthCheck>("Simple Degraded", tags: new[] {"Simple", "Degraded"})
    .AddCheck<SimpleFailedHealthCheck>("Simple Failed", tags: new[] {"Simple", "Failed"})
    .AddCheck<SimpleExceptionHealthCheck>("Simple Exception", tags: new[] {"Simple", "Exception"});

var app = builder.Build();
app.MapHealthChecks("/health");

// Use health dashboard and configure it as needed.
app.MapHealthCheckDashboard("/health-dashboard");

/* Normal auth, controller etc. setup.
...
*/

app.Run();

And that is it.

The dashboard follows mostly the same conventions that the health checks do.

Require authorization

Call RequireAuthorization to run Authorization Middleware on the health dashboard endpoint. A RequireAuthorization overload accepts one or more authorization policies. If a policy isn't provided, the default authorization policy is used:

  app.MapHealthCheckDashboard("/health-dashboard")
      .RequireAuthorization();

Filtering health checks

By default, the Health dashboard shows all registered health checks. To show a subset of health checks, provide a function that returns a boolean to the Predicate option.

The following example filters the health checks so that only those tagged with sample run:

app.MapHealthCheckDashboard("/health-dashboard", new HealthDashboardOptions
{
    Predicate = healthCheck => healthCheck.Tags.Contains("sample")
});
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 319 5/14/2025