Interface IHealthCheck

Namespace

WorkflowForge.Extensions.Observability.HealthChecks.Abstractions

Assembly

WorkflowForge.Extensions.Observability.HealthChecks.dll

Represents a health check that can be executed to determine the health status of a component.

public interface IHealthCheck

Properties

Description

Gets the description of what this health check validates.

string Description { get; }

Property Value

string

Name

Gets the name of the health check.

string Name { get; }

Property Value

string

Methods

CheckHealthAsync(CancellationToken)

Executes the health check asynchronously.

Task<HealthCheckResult> CheckHealthAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<HealthCheckResult>

A task representing the health check result.