[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation. (grpc依赖)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

74 lines
2.6 KiB

.. _config_cluster_manager_cluster_circuit_breakers:
Circuit breakers
================
* Circuit breaking :ref:`architecture overview <arch_overview_circuit_break>`.
* Priority routing :ref:`architecture overview <arch_overview_http_routing_priority>`.
Circuit breaking settings can be specified individually for each defined priority. How the
different priorities are used are documented in the sections of the configuration guide that use
them.
.. code-block:: json
{
"default": "{...}",
"high": "{...}"
}
default
*(optional, object)* Settings object for default priority.
high
*(optional, object)* Settings object for high priority.
Per priority settings
---------------------
.. code-block:: json
{
"max_connections": "...",
"max_pending_requests": "...",
"max_requests": "...",
"max_retries": "...",
}
.. _config_cluster_manager_cluster_circuit_breakers_max_connections:
max_connections
*(optional, integer)* The maximum number of connections that Envoy will make to the upstream
cluster. If not specified, the default is 1024. See the :ref:`circuit breaking overview
<arch_overview_circuit_break>` for more information.
.. _config_cluster_manager_cluster_circuit_breakers_max_pending_requests:
max_pending_requests
*(optional, integer)* The maximum number of pending requests that Envoy will allow to the upstream
cluster. If not specified, the default is 1024. See the :ref:`circuit breaking overview
<arch_overview_circuit_break>` for more information.
.. _config_cluster_manager_cluster_circuit_breakers_max_requests:
max_requests
*(optional, integer)* The maximum number of parallel requests that Envoy will make to the upstream
cluster. If not specified, the default is 1024. See the :ref:`circuit breaking overview
<arch_overview_circuit_break>` for more information.
.. _config_cluster_manager_cluster_circuit_breakers_max_retries:
max_retries
*(optional, integer)* The maximum number of parallel retries that Envoy will allow to the upstream
cluster. If not specified, the default is 3. See the :ref:`circuit breaking overview
<arch_overview_circuit_break>` for more information.
Runtime
-------
All four circuit breaking settings are runtime configurable for all defined priorities based on cluster
name. They follow the following naming scheme ``circuit_breakers.<cluster_name>.<priority>.<setting>``.
``cluster_name`` is the name field in each cluster's configuration, which is set in the envoy
:ref:`config file <config_cluster_manager_cluster_name>`. Available runtime settings will override
settings set in the envoy config file.