1// Copyright 2020 The gRPC Authors 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15// Local copy of Envoy xDS proto file, used for testing only. 16 17syntax = "proto3"; 18 19package envoy.config.cluster.v3; 20 21import "google/protobuf/duration.proto"; 22import "google/protobuf/wrappers.proto"; 23 24message OutlierDetection { 25 // The time interval between ejection analysis sweeps. This can result in 26 // both new ejections as well as hosts being returned to service. Defaults 27 // to 10000ms or 10s. 28 google.protobuf.Duration interval = 2; 29 30 // The base time that a host is ejected for. The real time is equal to the 31 // base time multiplied by the number of times the host has been ejected and is 32 // capped by :ref:`max_ejection_time<envoy_v3_api_field_config.cluster.v3.OutlierDetection.max_ejection_time>`. 33 // Defaults to 30000ms or 30s. 34 google.protobuf.Duration base_ejection_time = 3; 35 36 // The maximum % of an upstream cluster that can be ejected due to outlier 37 // detection. Defaults to 10% but will eject at least one host regardless of the value. 38 google.protobuf.UInt32Value max_ejection_percent = 4; 39 40 // The % chance that a host will be actually ejected when an outlier status 41 // is detected through success rate statistics. This setting can be used to 42 // disable ejection or to ramp it up slowly. Defaults to 100. 43 google.protobuf.UInt32Value enforcing_success_rate = 6; 44 45 // The number of hosts in a cluster that must have enough request volume to 46 // detect success rate outliers. If the number of hosts is less than this 47 // setting, outlier detection via success rate statistics is not performed 48 // for any host in the cluster. Defaults to 5. 49 google.protobuf.UInt32Value success_rate_minimum_hosts = 7; 50 51 // The minimum number of total requests that must be collected in one 52 // interval (as defined by the interval duration above) to include this host 53 // in success rate based outlier detection. If the volume is lower than this 54 // setting, outlier detection via success rate statistics is not performed 55 // for that host. Defaults to 100. 56 google.protobuf.UInt32Value success_rate_request_volume = 8; 57 58 // This factor is used to determine the ejection threshold for success rate 59 // outlier ejection. The ejection threshold is the difference between the 60 // mean success rate, and the product of this factor and the standard 61 // deviation of the mean success rate: mean - (stdev * 62 // success_rate_stdev_factor). This factor is divided by a thousand to get a 63 // double. That is, if the desired factor is 1.9, the runtime value should 64 // be 1900. Defaults to 1900. 65 google.protobuf.UInt32Value success_rate_stdev_factor = 9; 66 67 // The failure percentage to use when determining failure percentage-based outlier detection. If 68 // the failure percentage of a given host is greater than or equal to this value, it will be 69 // ejected. Defaults to 85. 70 google.protobuf.UInt32Value failure_percentage_threshold = 16; 71 72 // The % chance that a host will be actually ejected when an outlier status is detected through 73 // failure percentage statistics. This setting can be used to disable ejection or to ramp it up 74 // slowly. Defaults to 0. 75 // 76 // [#next-major-version: setting this without setting failure_percentage_threshold should be 77 // invalid in v4.] 78 google.protobuf.UInt32Value enforcing_failure_percentage = 17; 79 80 // The minimum number of hosts in a cluster in order to perform failure percentage-based ejection. 81 // If the total number of hosts in the cluster is less than this value, failure percentage-based 82 // ejection will not be performed. Defaults to 5. 83 google.protobuf.UInt32Value failure_percentage_minimum_hosts = 19; 84 85 // The minimum number of total requests that must be collected in one interval (as defined by the 86 // interval duration above) to perform failure percentage-based ejection for this host. If the 87 // volume is lower than this setting, failure percentage-based ejection will not be performed for 88 // this host. Defaults to 50. 89 google.protobuf.UInt32Value failure_percentage_request_volume = 20; 90 91 // 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>` 92 // for more information. If not specified, the default value (300000ms or 300s) or 93 // :ref:`base_ejection_time<envoy_v3_api_field_config.cluster.v3.OutlierDetection.base_ejection_time>` value is applied, whatever is larger. 94 google.protobuf.Duration max_ejection_time = 21; 95 96} 97