1syntax = "proto3";
2
3package envoy.config.cluster.v3;
4
5import "google/protobuf/duration.proto";
6import "google/protobuf/wrappers.proto";
7
8import "udpa/annotations/status.proto";
9import "udpa/annotations/versioning.proto";
10import "validate/validate.proto";
11
12option java_package = "io.envoyproxy.envoy.config.cluster.v3";
13option java_outer_classname = "OutlierDetectionProto";
14option java_multiple_files = true;
15option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3;clusterv3";
16option (udpa.annotations.file_status).package_version_status = ACTIVE;
17
18// [#protodoc-title: Outlier detection]
19
20// See the :ref:`architecture overview <arch_overview_outlier_detection>` for
21// more information on outlier detection.
22// [#next-free-field: 23]
23message OutlierDetection {
24  option (udpa.annotations.versioning).previous_message_type =
25      "envoy.api.v2.cluster.OutlierDetection";
26
27  // The number of consecutive server-side error responses (for HTTP traffic,
28  // 5xx responses; for TCP traffic, connection failures; for Redis, failure to
29  // respond PONG; etc.) before a consecutive 5xx ejection occurs. Defaults to 5.
30  google.protobuf.UInt32Value consecutive_5xx = 1;
31
32  // The time interval between ejection analysis sweeps. This can result in
33  // both new ejections as well as hosts being returned to service. Defaults
34  // to 10000ms or 10s.
35  google.protobuf.Duration interval = 2 [(validate.rules).duration = {gt {}}];
36
37  // The base time that a host is ejected for. The real time is equal to the
38  // base time multiplied by the number of times the host has been ejected and is
39  // capped by :ref:`max_ejection_time<envoy_v3_api_field_config.cluster.v3.OutlierDetection.max_ejection_time>`.
40  // Defaults to 30000ms or 30s.
41  google.protobuf.Duration base_ejection_time = 3 [(validate.rules).duration = {gt {}}];
42
43  // The maximum % of an upstream cluster that can be ejected due to outlier
44  // detection. Defaults to 10% but will eject at least one host regardless of the value.
45  google.protobuf.UInt32Value max_ejection_percent = 4 [(validate.rules).uint32 = {lte: 100}];
46
47  // The % chance that a host will be actually ejected when an outlier status
48  // is detected through consecutive 5xx. This setting can be used to disable
49  // ejection or to ramp it up slowly. Defaults to 100.
50  google.protobuf.UInt32Value enforcing_consecutive_5xx = 5 [(validate.rules).uint32 = {lte: 100}];
51
52  // The % chance that a host will be actually ejected when an outlier status
53  // is detected through success rate statistics. This setting can be used to
54  // disable ejection or to ramp it up slowly. Defaults to 100.
55  google.protobuf.UInt32Value enforcing_success_rate = 6 [(validate.rules).uint32 = {lte: 100}];
56
57  // The number of hosts in a cluster that must have enough request volume to
58  // detect success rate outliers. If the number of hosts is less than this
59  // setting, outlier detection via success rate statistics is not performed
60  // for any host in the cluster. Defaults to 5.
61  google.protobuf.UInt32Value success_rate_minimum_hosts = 7;
62
63  // The minimum number of total requests that must be collected in one
64  // interval (as defined by the interval duration above) to include this host
65  // in success rate based outlier detection. If the volume is lower than this
66  // setting, outlier detection via success rate statistics is not performed
67  // for that host. Defaults to 100.
68  google.protobuf.UInt32Value success_rate_request_volume = 8;
69
70  // This factor is used to determine the ejection threshold for success rate
71  // outlier ejection. The ejection threshold is the difference between the
72  // mean success rate, and the product of this factor and the standard
73  // deviation of the mean success rate: mean - (stdev *
74  // success_rate_stdev_factor). This factor is divided by a thousand to get a
75  // double. That is, if the desired factor is 1.9, the runtime value should
76  // be 1900. Defaults to 1900.
77  google.protobuf.UInt32Value success_rate_stdev_factor = 9;
78
79  // The number of consecutive gateway failures (502, 503, 504 status codes)
80  // before a consecutive gateway failure ejection occurs. Defaults to 5.
81  google.protobuf.UInt32Value consecutive_gateway_failure = 10;
82
83  // The % chance that a host will be actually ejected when an outlier status
84  // is detected through consecutive gateway failures. This setting can be
85  // used to disable ejection or to ramp it up slowly. Defaults to 0.
86  google.protobuf.UInt32Value enforcing_consecutive_gateway_failure = 11
87      [(validate.rules).uint32 = {lte: 100}];
88
89  // Determines whether to distinguish local origin failures from external errors. If set to true
90  // the following configuration parameters are taken into account:
91  // :ref:`consecutive_local_origin_failure<envoy_v3_api_field_config.cluster.v3.OutlierDetection.consecutive_local_origin_failure>`,
92  // :ref:`enforcing_consecutive_local_origin_failure<envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_consecutive_local_origin_failure>`
93  // and
94  // :ref:`enforcing_local_origin_success_rate<envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_local_origin_success_rate>`.
95  // Defaults to false.
96  bool split_external_local_origin_errors = 12;
97
98  // The number of consecutive locally originated failures before ejection
99  // occurs. Defaults to 5. Parameter takes effect only when
100  // :ref:`split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
101  // is set to true.
102  google.protobuf.UInt32Value consecutive_local_origin_failure = 13;
103
104  // The % chance that a host will be actually ejected when an outlier status
105  // is detected through consecutive locally originated failures. This setting can be
106  // used to disable ejection or to ramp it up slowly. Defaults to 100.
107  // Parameter takes effect only when
108  // :ref:`split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
109  // is set to true.
110  google.protobuf.UInt32Value enforcing_consecutive_local_origin_failure = 14
111      [(validate.rules).uint32 = {lte: 100}];
112
113  // The % chance that a host will be actually ejected when an outlier status
114  // is detected through success rate statistics for locally originated errors.
115  // This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
116  // Parameter takes effect only when
117  // :ref:`split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
118  // is set to true.
119  google.protobuf.UInt32Value enforcing_local_origin_success_rate = 15
120      [(validate.rules).uint32 = {lte: 100}];
121
122  // The failure percentage to use when determining failure percentage-based outlier detection. If
123  // the failure percentage of a given host is greater than or equal to this value, it will be
124  // ejected. Defaults to 85.
125  google.protobuf.UInt32Value failure_percentage_threshold = 16
126      [(validate.rules).uint32 = {lte: 100}];
127
128  // The % chance that a host will be actually ejected when an outlier status is detected through
129  // failure percentage statistics. This setting can be used to disable ejection or to ramp it up
130  // slowly. Defaults to 0.
131  //
132  // [#next-major-version: setting this without setting failure_percentage_threshold should be
133  // invalid in v4.]
134  google.protobuf.UInt32Value enforcing_failure_percentage = 17
135      [(validate.rules).uint32 = {lte: 100}];
136
137  // The % chance that a host will be actually ejected when an outlier status is detected through
138  // local-origin failure percentage statistics. This setting can be used to disable ejection or to
139  // ramp it up slowly. Defaults to 0.
140  google.protobuf.UInt32Value enforcing_failure_percentage_local_origin = 18
141      [(validate.rules).uint32 = {lte: 100}];
142
143  // The minimum number of hosts in a cluster in order to perform failure percentage-based ejection.
144  // If the total number of hosts in the cluster is less than this value, failure percentage-based
145  // ejection will not be performed. Defaults to 5.
146  google.protobuf.UInt32Value failure_percentage_minimum_hosts = 19;
147
148  // The minimum number of total requests that must be collected in one interval (as defined by the
149  // interval duration above) to perform failure percentage-based ejection for this host. If the
150  // volume is lower than this setting, failure percentage-based ejection will not be performed for
151  // this host. Defaults to 50.
152  google.protobuf.UInt32Value failure_percentage_request_volume = 20;
153
154  // The maximum time that a host is ejected for. See :ref:`base_ejection_time<envoy_v3_api_field_config.cluster.v3.OutlierDetection.base_ejection_time>`
155  // for more information. If not specified, the default value (300000ms or 300s) or
156  // :ref:`base_ejection_time<envoy_v3_api_field_config.cluster.v3.OutlierDetection.base_ejection_time>` value is applied, whatever is larger.
157  google.protobuf.Duration max_ejection_time = 21 [(validate.rules).duration = {gt {}}];
158
159  // The maximum amount of jitter to add to the ejection time, in order to prevent
160  // a 'thundering herd' effect where all proxies try to reconnect to host at the same time.
161  // See :ref:`max_ejection_time_jitter<envoy_v3_api_field_config.cluster.v3.OutlierDetection.base_ejection_time>`
162  // Defaults to 0s.
163  google.protobuf.Duration max_ejection_time_jitter = 22;
164}
165