App Metrics Fork me on GitHub
Show / Hide Table of Contents

Interface IProvideHealth

Provides access to the current health status of the application by executing regsitered HealthChecks

Namespace:App.Metrics.Health.Abstractions
Assembly:cs.temp.dll.dll
Syntax
public interface IProvideHealth

Methods

ReadStatusAsync(CancellationToken)

Executes all regsitered health checks within the application

Declaration
Task<HealthStatus> ReadStatusAsync(CancellationToken cancellationToken = null)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<HealthStatus>

The current health status of the application. A single health check failure will result in an un-healthy result

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX