Class TransportFailureRateHealthPolicyOptions

Defines options for the transport failure rate passive health policy.

Inheritance

System.Object

TransportFailureRateHealthPolicyOptions

Namespace: Yarp.ReverseProxy.Health

Assembly: Yarp.ReverseProxy.dll

Syntax

public class TransportFailureRateHealthPolicyOptions : object

Fields

FailureRateLimitMetadataName

Name of failure rate limit metadata parameter. Destination marked as unhealthy once this limit is reached.

Declaration

public static readonly string FailureRateLimitMetadataName

Field Value

Type	Description
System.String

Properties

DefaultFailureRateLimit

Default failure rate limit for a destination to be marked as unhealthy that is applied if it's not set on a cluster's metadata. It's calculated as a percentage of failed requests out of all requests proxied to the same destination in the DetectionWindowSize period. The value is in range (0,1). The default is 0.3 (30%).

Declaration

public double DefaultFailureRateLimit { get; set; }

Property Value

Type	Description
System.Double

DetectionWindowSize

Period of time while detected failures are kept and taken into account in the rate calculation. The default is 60 seconds.

Declaration

public TimeSpan DetectionWindowSize { get; set; }

Property Value

Type	Description
TimeSpan

MinimalTotalCountThreshold

Minimal total number of requests which must be proxied to a destination within the detection window before this policy starts evaluating the destination's health and enforcing the failure rate limit. The default is 10.

Declaration

public int MinimalTotalCountThreshold { get; set; }

Property Value

Type	Description
System.Int32