.. _envoy_api_file_api/filter/fault.proto:

Common fault injection types
============================


.. _envoy_api_msg_filter.FaultDelay:

filter.FaultDelay
-----------------

`[filter.FaultDelay proto] <https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/fault.proto#L13>`_

Delay specification is used to inject latency into the
HTTP/gRPC/Mongo/Redis operation or delay proxying of TCP connections.

.. code-block:: json

  {
    "type": "...",
    "percent": "...",
    "fixed_delay": "{...}"
  }

.. _envoy_api_field_filter.FaultDelay.type:

type
  (:ref:`filter.FaultDelay.FaultDelayType <envoy_api_enum_filter.FaultDelay.FaultDelayType>`) Delay type to use (fixed|exponential|..). Currently, only fixed delay (step function) is
  supported.
  
  
.. _envoy_api_field_filter.FaultDelay.percent:

percent
  (`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) An integer between 0-100 indicating the percentage of operations/connection requests
  on which the delay will be injected.
  
  
.. _envoy_api_field_filter.FaultDelay.fixed_delay:

fixed_delay
  (`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#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/Redis, the specified
  delay will be injected before a new request/operation. For TCP
  connections, the proxying of the connection upstream will be delayed
  for the specified period. This is required if type is FIXED.
  
  
  Precisely one of :ref:`fixed_delay <envoy_api_field_filter.FaultDelay.fixed_delay>` must be set.
  

.. _envoy_api_enum_filter.FaultDelay.FaultDelayType:

Enum filter.FaultDelay.FaultDelayType
-------------------------------------

`[filter.FaultDelay.FaultDelayType proto] <https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/fault.proto#L14>`_


.. _envoy_api_enum_value_filter.FaultDelay.FaultDelayType.FIXED:

FIXED
  *(DEFAULT)* ⁣Fixed delay (step function).