Interface IHealthContributor

Implement this interface and add to DI to be included in health checks.

Namespace: Steeltoe.Common.HealthChecks

Assembly: Steeltoe.Common.dll

Syntax

public interface IHealthContributor

Properties

Id

Gets an identifier for the type of check being performed.

Declaration

string Id { get; }

Property Value

Type	Description
System.String

Methods

CheckHealthAsync(CancellationToken)

Performs a health check.

Declaration

Task<HealthCheckResult> CheckHealthAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task<HealthCheckResult>	The result of the health check, or null if this health check is currently disabled.