package envoy.api.v2.cluster
Get desktop application:
View/edit binary Protocol Buffers messages
message
circuit_breaker.proto:27:ref:`Circuit breaking<arch_overview_circuit_break>` settings can be specified individually for each defined priority.
Used in:
repeated thresholds = 1
If multiple :ref:`Thresholds<envoy_api_msg_cluster.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`, the first one in the list is used. If no Thresholds is defined for a given :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`, the default values are used.
message
circuit_breaker.proto:31A Thresholds defines CircuitBreaker settings for a :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`. [#next-free-field: 9]
Used in:
core.RoutingPriority priority = 1
The :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>` the specified CircuitBreaker settings apply to.
optional max_connections = 2
The maximum number of connections that Envoy will make to the upstream cluster. If not specified, the default is 1024.
optional max_pending_requests = 3
The maximum number of pending requests that Envoy will allow to the upstream cluster. If not specified, the default is 1024.
optional max_requests = 4
The maximum number of parallel requests that Envoy will make to the upstream cluster. If not specified, the default is 1024.
optional max_retries = 5
The maximum number of parallel retries that Envoy will allow to the upstream cluster. If not specified, the default is 3.
optional retry_budget = 8
Specifies a limit on concurrent retries in relation to the number of active requests. This parameter is optional. .. note:: If this field is set, the retry budget will override any configured retry circuit breaker.
bool track_remaining = 6
If track_remaining is true, then stats will be published that expose the number of resources remaining until the circuit breakers open. If not specified, the default is false. .. note:: If a retry budget is used in lieu of the max_retries circuit breaker, the remaining retry resources remaining will not be tracked.
optional max_connection_pools = 7
The maximum number of connection pools per cluster that Envoy will concurrently support at once. If not specified, the default is unlimited. Set this for clusters which create a large number of connection pools. See :ref:`Circuit Breaking <arch_overview_circuit_break_cluster_maximum_connection_pools>` for more details.
message
circuit_breaker.proto:32Used in:
optional budget_percent = 1
Specifies the limit on concurrent retries as a percentage of the sum of active requests and active pending requests. For example, if there are 100 active requests and the budget_percent is set to 25, there may be 25 active retries. This parameter is optional. Defaults to 20%.
optional min_retry_concurrency = 2
Specifies the minimum retry concurrency allowed for the retry budget. The limit on the number of active retries may never go below this number. This parameter is optional. Defaults to 3.
message
filter.proto:23Used in:
string name = 1
The name of the filter to instantiate. The name must match a :ref:`supported filter <config_network_filters>`.
optional typed_config = 2
Filter specific configuration which depends on the filter being instantiated. See the supported filters for further documentation.
message
outlier_detection.proto:26See the :ref:`architecture overview <arch_overview_outlier_detection>` for more information on outlier detection. [#next-free-field: 21]
Used in:
optional consecutive_5xx = 1
The number of consecutive server-side error responses (for HTTP traffic, 5xx responses; for TCP traffic, connection failures; for Redis, failure to respond PONG; etc.) before a consecutive 5xx ejection occurs. Defaults to 5.
optional interval = 2
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.
optional base_ejection_time = 3
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.
optional max_ejection_percent = 4
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.
optional enforcing_consecutive_5xx = 5
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.
optional enforcing_success_rate = 6
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.
optional success_rate_minimum_hosts = 7
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.
optional success_rate_request_volume = 8
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.
optional success_rate_stdev_factor = 9
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.
optional consecutive_gateway_failure = 10
The number of consecutive gateway failures (502, 503, 504 status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
optional enforcing_consecutive_gateway_failure = 11
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.
bool split_external_local_origin_errors = 12
Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: :ref:`consecutive_local_origin_failure<envoy_api_field_cluster.OutlierDetection.consecutive_local_origin_failure>`, :ref:`enforcing_consecutive_local_origin_failure<envoy_api_field_cluster.OutlierDetection.enforcing_consecutive_local_origin_failure>` and :ref:`enforcing_local_origin_success_rate<envoy_api_field_cluster.OutlierDetection.enforcing_local_origin_success_rate>`. Defaults to false.
optional consecutive_local_origin_failure = 13
The number of consecutive locally originated failures before ejection occurs. Defaults to 5. Parameter takes effect only when :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is set to true.
optional enforcing_consecutive_local_origin_failure = 14
The % chance that a host will be actually ejected when an outlier status is detected through consecutive locally originated failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Parameter takes effect only when :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is set to true.
optional enforcing_local_origin_success_rate = 15
The % chance that a host will be actually ejected when an outlier status is detected through success rate statistics for locally originated errors. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Parameter takes effect only when :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is set to true.
optional failure_percentage_threshold = 16
The failure percentage to use when determining failure percentage-based outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85.
optional enforcing_failure_percentage = 17
The % chance that a host will be actually ejected when an outlier status is detected through failure percentage statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. [#next-major-version: setting this without setting failure_percentage_threshold should be invalid in v4.]
optional enforcing_failure_percentage_local_origin = 18
The % chance that a host will be actually ejected when an outlier status is detected through local-origin failure percentage statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
optional failure_percentage_minimum_hosts = 19
The minimum number of hosts in a cluster in order to perform failure percentage-based ejection. If the total number of hosts in the cluster is less than this value, failure percentage-based ejection will not be performed. Defaults to 5.
optional failure_percentage_request_volume = 20
The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to perform failure percentage-based ejection for this host. If the volume is lower than this setting, failure percentage-based ejection will not be performed for this host. Defaults to 50.