Common fault injection types

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/filter/fault/v2/fault.proto

extensions.filters.common.fault.v3.FaultDelay

[extensions.filters.common.fault.v3.FaultDelay proto]

Delay specification is used to inject latency into the HTTP/Mongo operation.

{
  "fixed_delay": "{...}",
  "header_delay": "{...}",
  "percentage": "{...}"
}

fixed_delay

(Duration) Add a fixed delay before forwarding the operation upstream. See https://developers.google.com/protocol-buffers/docs/proto3#json for the JSON/YAML Duration mapping. For HTTP/Mongo, the specified delay will be injected before a new request/operation. This is required if type is FIXED.

Precisely one of fixed_delay, header_delay must be set.

header_delay

(extensions.filters.common.fault.v3.FaultDelay.HeaderDelay) Fault delays are controlled via an HTTP header (if applicable).

Precisely one of fixed_delay, header_delay must be set.

percentage

(type.v3.FractionalPercent) The percentage of operations/connections/requests on which the delay will be injected.

extensions.filters.common.fault.v3.FaultDelay.HeaderDelay

[extensions.filters.common.fault.v3.FaultDelay.HeaderDelay proto]

Fault delays are controlled via an HTTP header (if applicable). See the HTTP fault filter documentation for more information.

Enum extensions.filters.common.fault.v3.FaultDelay.FaultDelayType

[extensions.filters.common.fault.v3.FaultDelay.FaultDelayType proto]

FIXED

(DEFAULT) ⁣Unused and deprecated.

extensions.filters.common.fault.v3.FaultRateLimit

[extensions.filters.common.fault.v3.FaultRateLimit proto]

Describes a rate limit to be applied.

{
  "fixed_limit": "{...}",
  "header_limit": "{...}",
  "percentage": "{...}"
}

fixed_limit

(extensions.filters.common.fault.v3.FaultRateLimit.FixedLimit) A fixed rate limit.

Precisely one of fixed_limit, header_limit must be set.

header_limit

(extensions.filters.common.fault.v3.FaultRateLimit.HeaderLimit) Rate limits are controlled via an HTTP header (if applicable).

Precisely one of fixed_limit, header_limit must be set.

percentage

(type.v3.FractionalPercent) The percentage of operations/connections/requests on which the rate limit will be injected.

extensions.filters.common.fault.v3.FaultRateLimit.FixedLimit

[extensions.filters.common.fault.v3.FaultRateLimit.FixedLimit proto]

Describes a fixed/constant rate limit.

{
  "limit_kbps": "..."
}

limit_kbps

(uint64) The limit supplied in KiB/s.

extensions.filters.common.fault.v3.FaultRateLimit.HeaderLimit

[extensions.filters.common.fault.v3.FaultRateLimit.HeaderLimit proto]

Rate limits are controlled via an HTTP header (if applicable). See the HTTP fault filter documentation for more information.