Health check

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/http/health_check/v2/health_check.proto

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.

Tip

This extension extends and can be used with the following extension category:

Health check configuration overview.

extensions.filters.http.health_check.v3.HealthCheck

[extensions.filters.http.health_check.v3.HealthCheck proto]

  1. {
  2.   "pass_through_mode": "{...}",
  3.   "cache_time": "{...}",
  4.   "cluster_min_healthy_percentages": "{...}",
  5.   "headers": []
  6. }

pass_through_mode

(BoolValue, REQUIRED) Specifies whether the filter operates in pass through mode or not.

cache_time

(Duration) If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.

cluster_min_healthy_percentages

(repeated map<string, type.v3.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%.

headers

(repeated config.route.v3.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.