Compute V1 Client - Class OutlierDetection (1.22.0)

Reference documentation and code samples for the Compute V1 Client class OutlierDetection.

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

Generated from protobuf message google.cloud.compute.v1.OutlierDetection

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ base_ejection_time`	`Duration` 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.
`↳ consecutive_errors`	`int` 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.
`↳ consecutive_gateway_failure`	`int` 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.
`↳ enforcing_consecutive_errors`	`int` 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.
`↳ enforcing_consecutive_gateway_failure`	`int` 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.
`↳ enforcing_success_rate`	`int` 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.
`↳ interval`	`Duration` 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.
`↳ max_ejection_percent`	`int` 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%.
`↳ success_rate_minimum_hosts`	`int` 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.
`↳ success_rate_request_volume`	`int` 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.
`↳ success_rate_stdev_factor`	`int` 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.

getBaseEjectionTime

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.

Returns
Type	Description
`Duration\|null`

hasBaseEjectionTime

clearBaseEjectionTime

setBaseEjectionTime

Parameter
Name	Description
`var`	`Duration`

Returns
Type	Description
`$this`

getConsecutiveErrors

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.

Returns
Type	Description
`int`

hasConsecutiveErrors

clearConsecutiveErrors

setConsecutiveErrors

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getConsecutiveGatewayFailure

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.

Returns
Type	Description
`int`

hasConsecutiveGatewayFailure

clearConsecutiveGatewayFailure

setConsecutiveGatewayFailure

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnforcingConsecutiveErrors

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.

Returns
Type	Description
`int`

hasEnforcingConsecutiveErrors

clearEnforcingConsecutiveErrors

setEnforcingConsecutiveErrors

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnforcingConsecutiveGatewayFailure

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.

Returns
Type	Description
`int`

hasEnforcingConsecutiveGatewayFailure

clearEnforcingConsecutiveGatewayFailure

setEnforcingConsecutiveGatewayFailure

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnforcingSuccessRate

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.

Returns
Type	Description
`int`

hasEnforcingSuccessRate

clearEnforcingSuccessRate

setEnforcingSuccessRate

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getInterval

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.

Returns
Type	Description
`Duration\|null`

hasInterval

clearInterval

setInterval

Parameter
Name	Description
`var`	`Duration`

Returns
Type	Description
`$this`

getMaxEjectionPercent

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%.

Returns
Type	Description
`int`

hasMaxEjectionPercent

clearMaxEjectionPercent

setMaxEjectionPercent

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%.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSuccessRateMinimumHosts

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.

Returns
Type	Description
`int`

hasSuccessRateMinimumHosts

clearSuccessRateMinimumHosts

setSuccessRateMinimumHosts

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSuccessRateRequestVolume

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.

Returns
Type	Description
`int`

hasSuccessRateRequestVolume

clearSuccessRateRequestVolume

setSuccessRateRequestVolume

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSuccessRateStdevFactor

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.

Returns
Type	Description
`int`

hasSuccessRateStdevFactor

clearSuccessRateStdevFactor

setSuccessRateStdevFactor

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`