Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::OutlierDetection (v1.8.0)

Version 1.8.0

• 2.14.0 (latest)
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::OutlierDetection.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#base_ejection_time

def base_ejection_time() -> ::Google::Cloud::Compute::V1::Duration

Returns

• (::Google::Cloud::Compute::V1::Duration) — The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

#base_ejection_time=

def base_ejection_time=(value) -> ::Google::Cloud::Compute::V1::Duration

Parameter

• value (::Google::Cloud::Compute::V1::Duration) — The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

Returns

• (::Google::Cloud::Compute::V1::Duration) — The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

#consecutive_errors

def consecutive_errors() -> ::Integer

Returns

• (::Integer) — Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#consecutive_errors=

def consecutive_errors=(value) -> ::Integer

Parameter

• value (::Integer) — Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns

• (::Integer) — Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#consecutive_gateway_failure

def consecutive_gateway_failure() -> ::Integer

Returns

• (::Integer) — 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#consecutive_gateway_failure=

def consecutive_gateway_failure=(value) -> ::Integer

Parameter

• value (::Integer) — 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns

• (::Integer) — 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#enforcing_consecutive_errors

def enforcing_consecutive_errors() -> ::Integer

Returns

• (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#enforcing_consecutive_errors=

def enforcing_consecutive_errors=(value) -> ::Integer

Parameter

• value (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns

• (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#enforcing_consecutive_gateway_failure

def enforcing_consecutive_gateway_failure() -> ::Integer

Returns

• (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#enforcing_consecutive_gateway_failure=

def enforcing_consecutive_gateway_failure=(value) -> ::Integer

Parameter

• value (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns

• (::Integer) — The percentage chance that a host will be actually 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

#enforcing_success_rate

def enforcing_success_rate() -> ::Integer

Returns

• (::Integer) — The percentage chance that a host will be actually 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.

#enforcing_success_rate=

def enforcing_success_rate=(value) -> ::Integer

Parameter

• value (::Integer) — The percentage chance that a host will be actually 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.

Returns

• (::Integer) — The percentage chance that a host will be actually 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.

#interval

def interval() -> ::Google::Cloud::Compute::V1::Duration

Returns

• (::Google::Cloud::Compute::V1::Duration) — Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

#interval=

def interval=(value) -> ::Google::Cloud::Compute::V1::Duration

Parameter

• value (::Google::Cloud::Compute::V1::Duration) — Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

Returns

• (::Google::Cloud::Compute::V1::Duration) — Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

#max_ejection_percent

def max_ejection_percent() -> ::Integer

Returns

• (::Integer) — Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

#max_ejection_percent=

def max_ejection_percent=(value) -> ::Integer

Parameter

• value (::Integer) — Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

Returns

• (::Integer) — Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

#success_rate_minimum_hosts

def success_rate_minimum_hosts() -> ::Integer

Returns

• (::Integer) — The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

#success_rate_minimum_hosts=

def success_rate_minimum_hosts=(value) -> ::Integer

Parameter

• value (::Integer) — The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

Returns

• (::Integer) — The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

#success_rate_request_volume

def success_rate_request_volume() -> ::Integer

Returns

• (::Integer) — The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host 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 host. Defaults to 100.

#success_rate_request_volume=

def success_rate_request_volume=(value) -> ::Integer

Parameter

• value (::Integer) — The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host 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 host. Defaults to 100.

Returns

• (::Integer) — The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host 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 host. Defaults to 100.

#success_rate_stdev_factor

def success_rate_stdev_factor() -> ::Integer

Returns

• (::Integer) — 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 * success_rate_stdev_factor). 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.

#success_rate_stdev_factor=

def success_rate_stdev_factor=(value) -> ::Integer

Parameter

• value (::Integer) — 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 * success_rate_stdev_factor). 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.

Returns

• (::Integer) — 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 * success_rate_stdev_factor). 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.