Class: Google::Apis::ComputeV1::OutlierDetection
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::OutlierDetection
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb
Overview
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
Instance Attribute Summary collapse
-
#base_ejection_time ⇒ Google::Apis::ComputeV1::Duration
A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution.
-
#consecutive_errors ⇒ Fixnum
Number of errors before a host is ejected from the connection pool.
-
#consecutive_gateway_failure ⇒ Fixnum
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.
-
#enforcing_consecutive_errors ⇒ Fixnum
The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.
-
#enforcing_consecutive_gateway_failure ⇒ Fixnum
The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.
-
#enforcing_success_rate ⇒ Fixnum
The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics.
-
#interval ⇒ Google::Apis::ComputeV1::Duration
A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution.
-
#max_ejection_percent ⇒ Fixnum
Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected.
-
#success_rate_minimum_hosts ⇒ Fixnum
The number of hosts in a cluster that must have enough request volume to detect success rate outliers.
-
#success_rate_request_volume ⇒ Fixnum
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.
-
#success_rate_stdev_factor ⇒ Fixnum
This factor is used to determine the ejection threshold for success rate outlier ejection.
Instance Method Summary collapse
-
#initialize(**args) ⇒ OutlierDetection
constructor
A new instance of OutlierDetection.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ OutlierDetection
Returns a new instance of OutlierDetection.
18800 18801 18802 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18800 def initialize(**args) update!(**args) end |
Instance Attribute Details
#base_ejection_time ⇒ Google::Apis::ComputeV1::Duration
A Duration represents a fixed-length span of time represented as a count of
seconds and fractions of seconds at nanosecond resolution. It is independent
of any calendar and concepts like "day" or "month". Range is approximately 10,
000 years.
Corresponds to the JSON property baseEjectionTime
18722 18723 18724 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18722 def base_ejection_time @base_ejection_time end |
#consecutive_errors ⇒ Fixnum
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.
Corresponds to the JSON property consecutiveErrors
18729 18730 18731 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18729 def consecutive_errors @consecutive_errors end |
#consecutive_gateway_failure ⇒ Fixnum
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.
Corresponds to the JSON property consecutiveGatewayFailure
18736 18737 18738 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18736 def consecutive_gateway_failure @consecutive_gateway_failure end |
#enforcing_consecutive_errors ⇒ Fixnum
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.
Corresponds to the JSON property enforcingConsecutiveErrors
18743 18744 18745 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18743 def enforcing_consecutive_errors @enforcing_consecutive_errors end |
#enforcing_consecutive_gateway_failure ⇒ Fixnum
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.
Corresponds to the JSON property enforcingConsecutiveGatewayFailure
18750 18751 18752 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18750 def enforcing_consecutive_gateway_failure @enforcing_consecutive_gateway_failure end |
#enforcing_success_rate ⇒ Fixnum
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.
Corresponds to the JSON property enforcingSuccessRate
18757 18758 18759 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18757 def enforcing_success_rate @enforcing_success_rate end |
#interval ⇒ Google::Apis::ComputeV1::Duration
A Duration represents a fixed-length span of time represented as a count of
seconds and fractions of seconds at nanosecond resolution. It is independent
of any calendar and concepts like "day" or "month". Range is approximately 10,
000 years.
Corresponds to the JSON property interval
18765 18766 18767 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18765 def interval @interval end |
#max_ejection_percent ⇒ Fixnum
Maximum percentage of hosts in the load balancing pool for the backend service
that can be ejected. Defaults to 50%.
Corresponds to the JSON property maxEjectionPercent
18771 18772 18773 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18771 def max_ejection_percent @max_ejection_percent end |
#success_rate_minimum_hosts ⇒ Fixnum
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.
Corresponds to the JSON property successRateMinimumHosts
18779 18780 18781 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18779 def success_rate_minimum_hosts @success_rate_minimum_hosts end |
#success_rate_request_volume ⇒ Fixnum
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.
Corresponds to the JSON property successRateRequestVolume
18788 18789 18790 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18788 def success_rate_request_volume @success_rate_request_volume end |
#success_rate_stdev_factor ⇒ Fixnum
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.
Corresponds to the JSON property successRateStdevFactor
18798 18799 18800 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18798 def success_rate_stdev_factor @success_rate_stdev_factor end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 18815 18816 18817 |
# File 'generated/google/apis/compute_v1/classes.rb', line 18805 def update!(**args) @base_ejection_time = args[:base_ejection_time] if args.key?(:base_ejection_time) @consecutive_errors = args[:consecutive_errors] if args.key?(:consecutive_errors) @consecutive_gateway_failure = args[:consecutive_gateway_failure] if args.key?(:consecutive_gateway_failure) @enforcing_consecutive_errors = args[:enforcing_consecutive_errors] if args.key?(:enforcing_consecutive_errors) @enforcing_consecutive_gateway_failure = args[:enforcing_consecutive_gateway_failure] if args.key?(:enforcing_consecutive_gateway_failure) @enforcing_success_rate = args[:enforcing_success_rate] if args.key?(:enforcing_success_rate) @interval = args[:interval] if args.key?(:interval) @max_ejection_percent = args[:max_ejection_percent] if args.key?(:max_ejection_percent) @success_rate_minimum_hosts = args[:success_rate_minimum_hosts] if args.key?(:success_rate_minimum_hosts) @success_rate_request_volume = args[:success_rate_request_volume] if args.key?(:success_rate_request_volume) @success_rate_stdev_factor = args[:success_rate_stdev_factor] if args.key?(:success_rate_stdev_factor) end |