Class DefaultHealthCheckService

A default implementation for IHealthCheckService.

public class DefaultHealthCheckService : IHealthCheckService

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Gets the collection of health check registrations.

public ICollection<HealthCheckRegistration> Registrations { get; }

Runs the provided health checks and returns the aggregated status

public Task<HealthReport> CheckHealthAsync(Func<HealthCheckRegistration, bool> predicate, CancellationToken cancellationToken = default)

predicate Func<HealthCheckRegistration, bool>: A predicate that can be used to include health checks based on user-defined criteria.
cancellationToken CancellationToken: A CancellationToken which can be used to cancel the health checks.

Task<HealthReport>: A Task<TResult> which will complete when all the health checks have been run, yielding a HealthReport containing the results.

Runs all the health checks in the application and returns the aggregated status.

public Task<HealthReport> CheckHealthAsync(CancellationToken cancellationToken = default)

cancellationToken CancellationToken: A CancellationToken which can be used to cancel the health checks.

Task<HealthReport>: A Task<TResult> which will complete when all the health checks have been run, yielding a HealthReport containing the results.