Interface IHealthCheck

Namespace

Acuit.Pinpoint.HealthChecks

Assembly

Acuit.Pinpoint.HealthChecks.dll

Represents a health check, which can be used to check the status of a component in the application. state.

public interface IHealthCheck

Methods

CheckHealthAsync(HealthCheckRegistration, CancellationToken)

Runs the health check, returning the status of the component being checked.

Task<HealthCheckResult> CheckHealthAsync(HealthCheckRegistration registration, CancellationToken cancellationToken = default)

Parameters

registration HealthCheckRegistration

The health check registration associated with the current execution.

cancellationToken CancellationToken

A CancellationToken that can be used to cancel the health check.

Returns

Task<HealthCheckResult>

A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked.