Class PipelineHealthCheck<T>

Namespace

Pipelinez.Core.Operational

Assembly

Pipelinez.dll

Adapts a Pipelinez pipeline into a standard ASP.NET Core health check.

public sealed class PipelineHealthCheck<T> : IHealthCheck where T : PipelineRecord

Type Parameters

T

The pipeline record type handled by the pipeline.

Inheritance

object

PipelineHealthCheck<T>

Implements

IHealthCheck

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PipelineHealthCheck(IPipeline<T>, bool)

Initializes a new pipeline health check.

public PipelineHealthCheck(IPipeline<T> pipeline, bool includeComponentDiagnostics = true)

Parameters

pipeline IPipeline<T>

The pipeline to inspect.

includeComponentDiagnostics bool

A value indicating whether component status information should be included in the health-check payload.

Methods

CheckHealthAsync(HealthCheckContext, CancellationToken)

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

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

Parameters

context HealthCheckContext

A context object 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.