Show / Hide Table of Contents

Interface IActiveHealthCheckMonitor

Actively monitors destinations health.

Namespace: Yarp.ReverseProxy.Health
Assembly: Yarp.ReverseProxy.dll
Syntax
public interface IActiveHealthCheckMonitor

Properties

| Improve this Doc View Source

InitialProbeCompleted

Gets a value that determines whether the initial round of active health checks have run, regardless of the results.

Declaration
bool InitialProbeCompleted { get; }
Property Value
Type Description
Boolean

false until the initial round of health check requests has been processed. true when all the initially configured destinations have been queried, regardless their availability or returned status code. The property stays true for the rest of the proxy process lifetime.

Methods

| Improve this Doc View Source

CheckHealthAsync(IEnumerable<ClusterState>)

Checks health of all clusters' destinations.

Declaration
Task CheckHealthAsync(IEnumerable<ClusterState> clusters)
Parameters
Type Name Description
IEnumerable<ClusterState> clusters

Clusters to check the health of their destinations.

Returns
Type Description
Task

representing the health check process.

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX