Interface IHealthCheckPublisher

Namespace: Acuit.Pinpoint.HealthChecks

Assembly: Acuit.Pinpoint.HealthChecks.dll

Represents a publisher of HealthReport information.

public interface IHealthCheckPublisher

Remarks

The default health checks implementation provided an IHostedService implementation that can be used to execute health checks at regular intervals and provide the resulting HealthReport data to all registered IHealthCheckPublisher instances.

To provide an IHealthCheckPublisher implementation, register an instance or type as a singleton service in the dependency injection container.

IHealthCheckPublisher instances are provided with a HealthReport after executing health checks in a background thread.

Methods

PublishAsync(HealthReport, CancellationToken)

Publishes the provided report.

Task PublishAsync(HealthReport report, CancellationToken cancellationToken)

Parameters

report HealthReport: The HealthReport. The result of executing a set of health checks.
cancellationToken CancellationToken: The CancellationToken.

Returns