Interface IActiveHealthCheckMonitor

Namespace

Yarp.ReverseProxy.Health

Assembly

Yarp.ReverseProxy.dll

Actively monitors destinations health.

public interface IActiveHealthCheckMonitor

Properties

InitialProbeCompleted

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

bool InitialProbeCompleted { get; }

Property Value

bool

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

CheckHealthAsync(IEnumerable<ClusterState>)

Checks health of all clusters' destinations.

Task CheckHealthAsync(IEnumerable<ClusterState> clusters)

Parameters

clusters IEnumerable<ClusterState>

Clusters to check the health of their destinations.

Returns

Task

Task representing the health check process.