Class: Google::Apis::ComputeAlpha::OutlierDetection

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OutlierDetection

Returns a new instance of OutlierDetection.



28295
28296
28297
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28295

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#base_ejection_time ⇒ Google::Apis::ComputeAlpha::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

Returns:



28217
28218
28219
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28217

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

Returns:

  • (Fixnum) 


28224
28225
28226
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28224

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

Returns:

  • (Fixnum) 


28231
28232
28233
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28231

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

Returns:

  • (Fixnum) 


28238
28239
28240
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28238

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

Returns:

  • (Fixnum) 


28245
28246
28247
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28245

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

Returns:

  • (Fixnum) 


28252
28253
28254
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28252

def enforcing_success_rate
  @enforcing_success_rate
end

#interval ⇒ Google::Apis::ComputeAlpha::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

Returns:



28260
28261
28262
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28260

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

Returns:

  • (Fixnum) 


28266
28267
28268
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28266

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

Returns:

  • (Fixnum) 


28274
28275
28276
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28274

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

Returns:

  • (Fixnum) 


28283
28284
28285
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28283

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

Returns:

  • (Fixnum) 


28293
28294
28295
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28293

def success_rate_stdev_factor
  @success_rate_stdev_factor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28300
28301
28302
28303
28304
28305
28306
28307
28308
28309
28310
28311
28312
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28300

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