Skip to content

Commit

Permalink
Clarify Consecutive Gateway Failure docs (#14738)
Browse files Browse the repository at this point in the history
It was initially unclear to me that when
split_external_local_origin_errors is in the default setting of false
that local origin failures will be counted as Consecutive Gateway
Failures. It is clear above that they are counted by the Consecutive 5xx
detection type but since I had that disabled I was surprised to find
them counted in Consecutive Gateway Failure. I think the logic makes
sense though so just attempting to clarify the docs here.

Signed-off-by: Matthew Mead-Briggs <mmb@yelp.com>
  • Loading branch information
mattmb authored Jan 20, 2021
1 parent f2f6943 commit ddba1f0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/root/intro/arch_overview/upstream/outlier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,9 @@ the :ref:`outlier_detection.consecutive_5xx<envoy_v3_api_field_config.cluster.v3
Consecutive Gateway Failure
^^^^^^^^^^^^^^^^^^^^^^^^^^^

This detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code)
and is supported only by the :ref:`http router <config_http_filters_router>`.
In the default mode (:ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>` is *false*) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and local origin failures, such as timeout, TCP reset etc.

In split mode (:ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>` is *true*) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and is supported only by the :ref:`http router <config_http_filters_router>`.

If an upstream host returns some number of consecutive "gateway errors" (502, 503 or 504 status
code), it will be ejected.
Expand Down

0 comments on commit ddba1f0

Please sign in to comment.