envoy.api.v2.cluster

Interface OutlierDetectionOuterClass.OutlierDetectionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OutlierDetectionOuterClass.OutlierDetection, OutlierDetectionOuterClass.OutlierDetection.Builder

Enclosing class:

OutlierDetectionOuterClass

public static interface OutlierDetectionOuterClass.OutlierDetectionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Duration	getBaseEjectionTime() The base time that a host is ejected for.
com.google.protobuf.DurationOrBuilder	getBaseEjectionTimeOrBuilder() The base time that a host is ejected for.
com.google.protobuf.UInt32Value	getConsecutive5Xx() The number of consecutive 5xx responses before a consecutive 5xx ejection occurs.
com.google.protobuf.UInt32ValueOrBuilder	getConsecutive5XxOrBuilder() The number of consecutive 5xx responses before a consecutive 5xx ejection occurs.
com.google.protobuf.UInt32Value	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.
com.google.protobuf.UInt32ValueOrBuilder	getConsecutiveGatewayFailureOrBuilder() 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.
com.google.protobuf.UInt32Value	getEnforcingConsecutive5Xx() The % chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.
com.google.protobuf.UInt32ValueOrBuilder	getEnforcingConsecutive5XxOrBuilder() The % chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.
com.google.protobuf.UInt32Value	getEnforcingConsecutiveGatewayFailure() The % chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.
com.google.protobuf.UInt32ValueOrBuilder	getEnforcingConsecutiveGatewayFailureOrBuilder() The % chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.
com.google.protobuf.UInt32Value	getEnforcingSuccessRate() The % chance that a host will be actually ejected when an outlier status is detected through success rate statistics.
com.google.protobuf.UInt32ValueOrBuilder	getEnforcingSuccessRateOrBuilder() The % chance that a host will be actually ejected when an outlier status is detected through success rate statistics.
com.google.protobuf.Duration	getInterval() The time interval between ejection analysis sweeps.
com.google.protobuf.DurationOrBuilder	getIntervalOrBuilder() The time interval between ejection analysis sweeps.
com.google.protobuf.UInt32Value	getMaxEjectionPercent() The maximum % of an upstream cluster that can be ejected due to outlier detection.
com.google.protobuf.UInt32ValueOrBuilder	getMaxEjectionPercentOrBuilder() The maximum % of an upstream cluster that can be ejected due to outlier detection.
com.google.protobuf.UInt32Value	getSuccessRateMinimumHosts() The number of hosts in a cluster that must have enough request volume to detect success rate outliers.
com.google.protobuf.UInt32ValueOrBuilder	getSuccessRateMinimumHostsOrBuilder() The number of hosts in a cluster that must have enough request volume to detect success rate outliers.
com.google.protobuf.UInt32Value	getSuccessRateRequestVolume() 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.
com.google.protobuf.UInt32ValueOrBuilder	getSuccessRateRequestVolumeOrBuilder() 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.
com.google.protobuf.UInt32Value	getSuccessRateStdevFactor() This factor is used to determine the ejection threshold for success rate outlier ejection.
com.google.protobuf.UInt32ValueOrBuilder	getSuccessRateStdevFactorOrBuilder() This factor is used to determine the ejection threshold for success rate outlier ejection.
boolean	hasBaseEjectionTime() The base time that a host is ejected for.
boolean	hasConsecutive5Xx() The number of consecutive 5xx responses before a consecutive 5xx ejection occurs.
boolean	hasConsecutiveGatewayFailure() 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.
boolean	hasEnforcingConsecutive5Xx() The % chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx.
boolean	hasEnforcingConsecutiveGatewayFailure() The % chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures.
boolean	hasEnforcingSuccessRate() The % chance that a host will be actually ejected when an outlier status is detected through success rate statistics.
boolean	hasInterval() The time interval between ejection analysis sweeps.
boolean	hasMaxEjectionPercent() The maximum % of an upstream cluster that can be ejected due to outlier detection.
boolean	hasSuccessRateMinimumHosts() The number of hosts in a cluster that must have enough request volume to detect success rate outliers.
boolean	hasSuccessRateRequestVolume() 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.
boolean	hasSuccessRateStdevFactor() This factor is used to determine the ejection threshold for success rate outlier ejection.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasConsecutive5Xx

boolean hasConsecutive5Xx()

 The number of consecutive 5xx responses before a consecutive 5xx ejection
 occurs. Defaults to 5.
 

.google.protobuf.UInt32Value consecutive_5xx = 1;

getConsecutive5Xx

com.google.protobuf.UInt32Value getConsecutive5Xx()

 The number of consecutive 5xx responses before a consecutive 5xx ejection
 occurs. Defaults to 5.
 

.google.protobuf.UInt32Value consecutive_5xx = 1;

getConsecutive5XxOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getConsecutive5XxOrBuilder()

 The number of consecutive 5xx responses before a consecutive 5xx ejection
 occurs. Defaults to 5.
 

.google.protobuf.UInt32Value consecutive_5xx = 1;

hasInterval

boolean hasInterval()

 The time interval between ejection analysis sweeps. This can result in
 both new ejections as well as hosts being returned to service. Defaults
 to 10000ms or 10s.
 

.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }

getInterval

com.google.protobuf.Duration getInterval()

 The time interval between ejection analysis sweeps. This can result in
 both new ejections as well as hosts being returned to service. Defaults
 to 10000ms or 10s.
 

.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }

getIntervalOrBuilder

com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()

 The time interval between ejection analysis sweeps. This can result in
 both new ejections as well as hosts being returned to service. Defaults
 to 10000ms or 10s.
 

.google.protobuf.Duration interval = 2 [(.validate.rules) = { ... }

hasBaseEjectionTime

boolean hasBaseEjectionTime()

 The base time that a host is ejected for. The real time is equal to the
 base time multiplied by the number of times the host has been ejected.
 Defaults to 30000ms or 30s.
 

.google.protobuf.Duration base_ejection_time = 3 [(.validate.rules) = { ... }

getBaseEjectionTime

com.google.protobuf.Duration getBaseEjectionTime()

 The base time that a host is ejected for. The real time is equal to the
 base time multiplied by the number of times the host has been ejected.
 Defaults to 30000ms or 30s.
 

.google.protobuf.Duration base_ejection_time = 3 [(.validate.rules) = { ... }

getBaseEjectionTimeOrBuilder

com.google.protobuf.DurationOrBuilder getBaseEjectionTimeOrBuilder()

 The base time that a host is ejected for. The real time is equal to the
 base time multiplied by the number of times the host has been ejected.
 Defaults to 30000ms or 30s.
 

.google.protobuf.Duration base_ejection_time = 3 [(.validate.rules) = { ... }

hasMaxEjectionPercent

boolean hasMaxEjectionPercent()

 The maximum % of an upstream cluster that can be ejected due to outlier
 detection. Defaults to 10% but will eject at least one host regardless of the value.
 

.google.protobuf.UInt32Value max_ejection_percent = 4 [(.validate.rules) = { ... }

getMaxEjectionPercent

com.google.protobuf.UInt32Value getMaxEjectionPercent()

 The maximum % of an upstream cluster that can be ejected due to outlier
 detection. Defaults to 10% but will eject at least one host regardless of the value.
 

.google.protobuf.UInt32Value max_ejection_percent = 4 [(.validate.rules) = { ... }

getMaxEjectionPercentOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getMaxEjectionPercentOrBuilder()

 The maximum % of an upstream cluster that can be ejected due to outlier
 detection. Defaults to 10% but will eject at least one host regardless of the value.
 

.google.protobuf.UInt32Value max_ejection_percent = 4 [(.validate.rules) = { ... }

hasEnforcingConsecutive5Xx

boolean hasEnforcingConsecutive5Xx()

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

.google.protobuf.UInt32Value enforcing_consecutive_5xx = 5 [(.validate.rules) = { ... }

getEnforcingConsecutive5Xx

com.google.protobuf.UInt32Value getEnforcingConsecutive5Xx()

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

.google.protobuf.UInt32Value enforcing_consecutive_5xx = 5 [(.validate.rules) = { ... }

getEnforcingConsecutive5XxOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getEnforcingConsecutive5XxOrBuilder()

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

.google.protobuf.UInt32Value enforcing_consecutive_5xx = 5 [(.validate.rules) = { ... }

hasEnforcingSuccessRate

boolean hasEnforcingSuccessRate()

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

.google.protobuf.UInt32Value enforcing_success_rate = 6 [(.validate.rules) = { ... }

getEnforcingSuccessRate

com.google.protobuf.UInt32Value getEnforcingSuccessRate()

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

.google.protobuf.UInt32Value enforcing_success_rate = 6 [(.validate.rules) = { ... }

getEnforcingSuccessRateOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getEnforcingSuccessRateOrBuilder()

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

.google.protobuf.UInt32Value enforcing_success_rate = 6 [(.validate.rules) = { ... }

hasSuccessRateMinimumHosts

boolean hasSuccessRateMinimumHosts()

 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.
 

.google.protobuf.UInt32Value success_rate_minimum_hosts = 7;

getSuccessRateMinimumHosts

com.google.protobuf.UInt32Value getSuccessRateMinimumHosts()

 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.
 

.google.protobuf.UInt32Value success_rate_minimum_hosts = 7;

getSuccessRateMinimumHostsOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getSuccessRateMinimumHostsOrBuilder()

 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.
 

.google.protobuf.UInt32Value success_rate_minimum_hosts = 7;

hasSuccessRateRequestVolume

boolean hasSuccessRateRequestVolume()

 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.
 

.google.protobuf.UInt32Value success_rate_request_volume = 8;

getSuccessRateRequestVolume

com.google.protobuf.UInt32Value getSuccessRateRequestVolume()

 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.
 

.google.protobuf.UInt32Value success_rate_request_volume = 8;

getSuccessRateRequestVolumeOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getSuccessRateRequestVolumeOrBuilder()

 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.
 

.google.protobuf.UInt32Value success_rate_request_volume = 8;

hasSuccessRateStdevFactor

boolean hasSuccessRateStdevFactor()

 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.
 

.google.protobuf.UInt32Value success_rate_stdev_factor = 9;

getSuccessRateStdevFactor

com.google.protobuf.UInt32Value 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 *
 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.
 

.google.protobuf.UInt32Value success_rate_stdev_factor = 9;

getSuccessRateStdevFactorOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getSuccessRateStdevFactorOrBuilder()

 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.
 

.google.protobuf.UInt32Value success_rate_stdev_factor = 9;

hasConsecutiveGatewayFailure

boolean hasConsecutiveGatewayFailure()

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

.google.protobuf.UInt32Value consecutive_gateway_failure = 10;

getConsecutiveGatewayFailure

com.google.protobuf.UInt32Value 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 5.
 

.google.protobuf.UInt32Value consecutive_gateway_failure = 10;

getConsecutiveGatewayFailureOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getConsecutiveGatewayFailureOrBuilder()

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

.google.protobuf.UInt32Value consecutive_gateway_failure = 10;

hasEnforcingConsecutiveGatewayFailure

boolean hasEnforcingConsecutiveGatewayFailure()

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

.google.protobuf.UInt32Value enforcing_consecutive_gateway_failure = 11 [(.validate.rules) = { ... }

getEnforcingConsecutiveGatewayFailure

com.google.protobuf.UInt32Value getEnforcingConsecutiveGatewayFailure()

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

.google.protobuf.UInt32Value enforcing_consecutive_gateway_failure = 11 [(.validate.rules) = { ... }

getEnforcingConsecutiveGatewayFailureOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getEnforcingConsecutiveGatewayFailureOrBuilder()

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

.google.protobuf.UInt32Value enforcing_consecutive_gateway_failure = 11 [(.validate.rules) = { ... }