Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization

This provides configurable health check reporting based on the current system resource utilization. See Microsoft.Extensions.Diagnostics.ResourceMonitoring for details on how resources are measured. See the health checks documentation for general usage guidance.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization

Or directly in the C# project file:

<ItemGroup> <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization" Version="[CURRENTVERSION]" /> </ItemGroup>

Usage Example

The health check services can be registered and configured using any of the following API:

public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, params string[] tags) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, IEnumerable<string> tags) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, IConfigurationSection section) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, IConfigurationSection section, params string[] tags) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, IConfigurationSection section, IEnumerable<string> tags) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, Action<ResourceUtilizationHealthCheckOptions> configure) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, Action<ResourceUtilizationHealthCheckOptions> configure, params string[] tags) public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, Action<ResourceUtilizationHealthCheckOptions> configure, IEnumerable<string> tags)

For example:

var builder = WebApplication.CreateBuilder(args); builder.Services.AddHealthChecks() .AddResourceUtilizationHealthCheck(o => { o.CpuThresholds = new ResourceUsageThresholds { DegradedUtilizationPercentage = 80, UnhealthyUtilizationPercentage = 90, }; o.MemoryThresholds = new ResourceUsageThresholds { DegradedUtilizationPercentage = 80, UnhealthyUtilizationPercentage = 90, }; o.SamplingWindow = TimeSpan.FromSeconds(5); }); var app = builder.Build(); app.MapHealthChecks("/healthz"); app.Run();