HealthCheckService Class

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks v9.0.0

Source:

HealthCheckService.cs

A service which can be used to check the status of IHealthCheck instances registered in the application.

public ref class HealthCheckService abstract

public abstract class HealthCheckService

type HealthCheckService = class

Public MustInherit Class HealthCheckService

Inheritance

Object

HealthCheckService

Remarks

The default implementation of HealthCheckService is registered in the dependency injection container as a singleton service by calling AddHealthChecks(IServiceCollection).

The IHealthChecksBuilder returned by AddHealthChecks(IServiceCollection) provides a convenience API for registering health checks.

IHealthCheck implementations can be registered through extension methods provided by IHealthChecksBuilder.

Constructors

HealthCheckService()

Methods

CheckHealthAsync(CancellationToken)	Runs all the health checks in the application and returns the aggregated status.
CheckHealthAsync(Func<HealthCheckRegistration,Boolean>, CancellationToken)	Runs the provided health checks and returns the aggregated status
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)