Compute Engine v1 API - Class OutlierDetection (3.1.0)

public sealed class OutlierDetection : IMessage<OutlierDetection>, IEquatable<OutlierDetection>, IDeepCloneable<OutlierDetection>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class OutlierDetection.

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

Inheritance

object > OutlierDetection

Implements

IMessage OutlierDetection, IEquatable OutlierDetection, IDeepCloneable OutlierDetection, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

OutlierDetection()

public OutlierDetection()

OutlierDetection(OutlierDetection)

public OutlierDetection(OutlierDetection other)

Parameter
Name	Description
`other`	`OutlierDetection`

Properties

BaseEjectionTime

public Duration BaseEjectionTime { get; set; }

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

Property Value
Type	Description
`Duration`

ConsecutiveErrors

public int ConsecutiveErrors { get; set; }

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

Property Value
Type	Description
`int`

ConsecutiveGatewayFailure

public int ConsecutiveGatewayFailure { get; set; }

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

Property Value
Type	Description
`int`

EnforcingConsecutiveErrors

public int EnforcingConsecutiveErrors { get; set; }

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

Property Value
Type	Description
`int`

EnforcingConsecutiveGatewayFailure

public int EnforcingConsecutiveGatewayFailure { get; set; }

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Property Value
Type	Description
`int`

EnforcingSuccessRate

public int EnforcingSuccessRate { get; set; }

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.

Property Value
Type	Description
`int`

HasConsecutiveErrors

public bool HasConsecutiveErrors { get; }

Gets whether the "consecutive_errors" field is set

Property Value
Type	Description
`bool`

HasConsecutiveGatewayFailure

public bool HasConsecutiveGatewayFailure { get; }

Gets whether the "consecutive_gateway_failure" field is set

Property Value
Type	Description
`bool`

HasEnforcingConsecutiveErrors

public bool HasEnforcingConsecutiveErrors { get; }

Gets whether the "enforcing_consecutive_errors" field is set

Property Value
Type	Description
`bool`

HasEnforcingConsecutiveGatewayFailure

public bool HasEnforcingConsecutiveGatewayFailure { get; }

Gets whether the "enforcing_consecutive_gateway_failure" field is set

Property Value
Type	Description
`bool`

HasEnforcingSuccessRate

public bool HasEnforcingSuccessRate { get; }

Gets whether the "enforcing_success_rate" field is set

Property Value
Type	Description
`bool`

HasMaxEjectionPercent

public bool HasMaxEjectionPercent { get; }

Gets whether the "max_ejection_percent" field is set

Property Value
Type	Description
`bool`

HasSuccessRateMinimumHosts

public bool HasSuccessRateMinimumHosts { get; }

Gets whether the "success_rate_minimum_hosts" field is set

Property Value
Type	Description
`bool`

HasSuccessRateRequestVolume

public bool HasSuccessRateRequestVolume { get; }

Gets whether the "success_rate_request_volume" field is set

Property Value
Type	Description
`bool`

HasSuccessRateStdevFactor

public bool HasSuccessRateStdevFactor { get; }

Gets whether the "success_rate_stdev_factor" field is set

Property Value
Type	Description
`bool`

Interval

public Duration Interval { get; set; }

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

Property Value
Type	Description
`Duration`

MaxEjectionPercent

public int MaxEjectionPercent { get; set; }

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

Property Value
Type	Description
`int`

SuccessRateMinimumHosts

public int SuccessRateMinimumHosts { get; set; }

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.

Property Value
Type	Description
`int`

SuccessRateRequestVolume

public int SuccessRateRequestVolume { get; set; }

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.

Property Value
Type	Description
`int`

SuccessRateStdevFactor

public int SuccessRateStdevFactor { get; set; }

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.

Property Value
Type	Description
`int`