Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions

Health check context. Provides health check registrations to .

Gets or sets the of the currently executing .

Represent the registration information associated with an implementation.

The health check registration is provided as a separate object so that application developers can customize how health check implementations are configured. The registration is provided to an implementation during execution through . This allows a health check implementation to access named options or perform other operations based on the registered name.

Creates a new for an existing instance.

The health check name. The instance. The that should be reported upon failure of the health check. If the provided value is null, then will be reported. A list of tags that can be used for filtering health checks.

Creates a new for an existing instance.

The health check name. The instance. The that should be reported upon failure of the health check. If the provided value is null, then will be reported. A list of tags that can be used for filtering health checks. An optional representing the timeout of the check.

Creates a new for an existing instance.

The health check name. A delegate used to create the instance. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used for filtering health checks.

Creates a new for an existing instance.

The health check name. A delegate used to create the instance. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used for filtering health checks. An optional representing the timeout of the check.

Gets or sets a delegate used to create the instance.

Gets or sets the that should be reported upon failure of the health check.

Gets or sets the timeout used for the test.

Gets or sets the individual delay applied to the health check after the application starts before executing instances. The delay is applied once at startup, and does not apply to subsequent iterations.

Gets or sets the individual period used for the check.

Gets or sets the health check name.

Gets a list of tags that can be used for filtering health checks.

Represents the result of a health check.

Creates a new with the specified values for , , , and .

A value indicating the status of the component that was checked. A human-readable description of the status of the component that was checked. An representing the exception that was thrown when checking for status (if any). Additional key-value pairs describing the health of the component.

Gets additional key-value pairs describing the health of the component.

Gets a human-readable description of the status of the component that was checked.

Gets an representing the exception that was thrown when checking for status (if any).

Gets a value indicating the status of the component that was checked.

Creates a representing a healthy component.

A human-readable description of the status of the component that was checked. Optional. Additional key-value pairs describing the health of the component. Optional. A representing a healthy component.

Creates a representing a degraded component.

A human-readable description of the status of the component that was checked. Optional. An representing the exception that was thrown when checking for status. Optional. Additional key-value pairs describing the health of the component. Optional. A representing a degraged component.

Creates a representing an unhealthy component.

A human-readable description of the status of the component that was checked. Optional. An representing the exception that was thrown when checking for status. Optional. Additional key-value pairs describing the health of the component. Optional. A representing an unhealthy component.

Represents the result of executing a group of instances.

Create a new from the specified results.

A containing the results from each health check. A value indicating the time the health check service took to execute.

Create a new from the specified results.

A containing the results from each health check. A representing the aggregate status of all the health checks. A value indicating the time the health check service took to execute.

A containing the results from each health check.

The keys in this dictionary map the name of each executed health check to a for the result data returned from the corresponding health check.

Gets a representing the aggregate status of all the health checks. The value of will be the most severe status reported by a health check. If no checks were executed, the value is always .

Gets the time the health check service took to execute.

Represents an entry in a . Corresponds to the result of a single .

Creates a new with the specified values for , , , and .

A value indicating the health status of the component that was checked. A human-readable description of the status of the component that was checked. A value indicating the health execution duration. An representing the exception that was thrown when checking for status (if any). Additional key-value pairs describing the health of the component.

Creates a new with the specified values for , , , and .

A value indicating the health status of the component that was checked. A human-readable description of the status of the component that was checked. A value indicating the health execution duration. An representing the exception that was thrown when checking for status (if any). Additional key-value pairs describing the health of the component. Tags associated with the health check that generated the report entry.

Gets additional key-value pairs describing the health of the component.

Gets a human-readable description of the status of the component that was checked.

Gets the health check execution duration.

Gets an representing the exception that was thrown when checking for status (if any).

Gets the health status of the component that was checked.

Gets the tags associated with the health check.

Represents the reported status of a health check result.

A status of should be considered the default value for a failing health check. Application developers may configure a health check to report a different status as desired. The values of this enum or ordered from least healthy to most healthy. So is greater than but less than .

Indicates that the health check determined that the component was unhealthy, or an unhandled exception was thrown while executing the health check.

Indicates that the health check determined that the component was in a degraded state.

Indicates that the health check determined that the component was healthy.

Represents a health check, which can be used to check the status of a component in the application, such as a backend service, database or some internal state.

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

A context object associated with the current execution. A that can be used to cancel the health check. A that completes when the health check has finished, yielding the status of the component being checked.

Represents a publisher of information.

The default health checks implementation provided an IHostedService implementation that can be used to execute health checks at regular intervals and provide the resulting data to all registered instances. To provide an implementation, register an instance or type as a singleton service in the dependency injection container. instances are provided with a after executing health checks in a background thread. The use of depend on hosting in an application using IWebHost or generic host (IHost). Execution of instance is not related to execution of health checks via a middleware.

Publishes the provided .

The . The result of executing a set of health checks. The . A which will complete when publishing is complete.

Throws an if is null.

The reference type argument to validate as non-null. The name of the parameter with which corresponds.

Throws an if is null or empty.

The argument to validate as non-null and non-empty. The name of the parameter with which corresponds.