Skip to content

Method CheckHealthAsync

Namespace: Belay.Extensions.HealthChecks
Assembly: Belay.Extensions.dll

CheckHealthAsync(HealthCheckContext, CancellationToken)

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

csharp
public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)

Parameters

context HealthCheckContext

A context object associated with the current execution.

cancellationToken CancellationToken

A that can be used to cancel the health check.

Returns

Task<HealthCheckResult>

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

Released under the Apache License 2.0.