package envoy.extensions.filters.http.admission_control.v3

Get desktop application:
View/edit binary Protocol Buffers messages

[#next-free-field: 8]

• optional config.core.v3.RuntimeFeatureFlag enabled = 1

  If set to false, the admission control filter will operate as a pass-through filter. If the message is unspecified, the filter will be enabled.

• oneof evaluation_criteria

  Defines how a request is considered a success/failure.

  • AdmissionControl.SuccessCriteria success_criteria = 2

• optional google.protobuf.Duration sampling_window = 3

  The sliding time window over which the success rate is calculated. The window is rounded to the nearest second. Defaults to 30s.

• optional config.core.v3.RuntimeDouble aggression = 4

  Rejection probability is defined by the formula:: max(0, (rq_count - rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression) The aggression dictates how heavily the admission controller will throttle requests upon SR dropping at or below the threshold. A value of 1 will result in a linear increase in rejection probability as SR drops. Any values less than 1.0, will be set to 1.0. If the message is unspecified, the aggression is 1.0. See `the admission control documentation <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/admission_control_filter.html>`_ for a diagram illustrating this.

• optional config.core.v3.RuntimePercent sr_threshold = 5

  Dictates the success rate at which the rejection probability is non-zero. As success rate drops below this threshold, rejection probability will increase. Any success rate above the threshold results in a rejection probability of 0. Defaults to 95%.

• optional config.core.v3.RuntimeUInt32 rps_threshold = 6

  If the average RPS of the sampling window is below this threshold, the request will not be rejected, even if the success rate is lower than sr_threshold. Defaults to 0.

• optional config.core.v3.RuntimePercent max_rejection_probability = 7

  The probability of rejection will never exceed this value, even if the failure rate is rising. Defaults to 80%.

Default method of specifying what constitutes a successful request. All status codes that indicate a successful request must be explicitly specified if not relying on the default values.

Used in: AdmissionControl

• optional SuccessCriteria.HttpCriteria http_criteria = 1

  If HTTP criteria are unspecified, all HTTP status codes below 500 are treated as successful responses. .. note:: The default HTTP codes considered successful by the admission controller are done so due to the unlikelihood that sending fewer requests would change their behavior (for example: redirects, unauthorized access, or bad requests won't be alleviated by sending less traffic).

• optional SuccessCriteria.GrpcCriteria grpc_criteria = 2

  GRPC status codes to consider as request successes. If unspecified, defaults to: Ok, Cancelled, Unknown, InvalidArgument, NotFound, AlreadyExists, Unauthenticated, FailedPrecondition, OutOfRange, PermissionDenied, and Unimplemented. .. note:: The default gRPC codes that are considered successful by the admission controller are chosen because of the unlikelihood that sending fewer requests will change the behavior.

Used in: SuccessCriteria

• repeated uint32 grpc_success_status = 1

  Status codes that constitute a successful request. Mappings can be found at: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.

Used in: SuccessCriteria

• repeated type.v3.Int32Range http_success_status = 1

  Status code ranges that constitute a successful request. Configurable codes are in the range [100, 600).