.. _envoy_api_file_envoy/config/filter/http/health_check/v2/health_check.proto: Health check ============ .. _extension_envoy.filters.http.health_check: This extension may be referenced by the qualified name *envoy.filters.http.health_check* .. note:: This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted. Health check :ref:`configuration overview `. .. _envoy_api_msg_config.filter.http.health_check.v2.HealthCheck: config.filter.http.health_check.v2.HealthCheck ---------------------------------------------- `[config.filter.http.health_check.v2.HealthCheck proto] `_ .. code-block:: json { "pass_through_mode": "{...}", "cache_time": "{...}", "cluster_min_healthy_percentages": "{...}", "headers": [] } .. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.pass_through_mode: pass_through_mode (`BoolValue `_, *REQUIRED*) Specifies whether the filter operates in pass through mode or not. .. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.cache_time: cache_time (`Duration `_) If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response. .. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.cluster_min_healthy_percentages: cluster_min_healthy_percentages (**repeated** map<`string `_, :ref:`type.Percent `>) If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy or degraded in order for the filter to return a 200. .. note:: This value is interpreted as an integer by truncating, so 12.50% will be calculated as if it were 12%. .. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.headers: headers (**repeated** :ref:`route.HeaderMatcher `) Specifies a set of health check request headers to match on. The health check filter will check a request’s headers against all the specified headers. To specify the health check endpoint, set the ``:path`` header to match on.