You are browsing documentation for an outdated version.
See the latest documentation here.
Health Check is an outbound policy. Dataplanes whose configuration is modified are in the
This policy enables Kong Mesh to keep track of the health of every data plane proxy, with the goal of minimizing the number of failed requests in case a data plane proxy is temporarily unhealthy.
By creating an
HealthCheck resource we can instruct a data plane proxy to keep track of the health status for any other data plane proxy. When health-checks are properly configured, a data plane proxy will never send a request to another data plane proxy that is considered unhealthy. When an unhealthy proxy returns to a healthy state, Kong Mesh will resume sending requests to it again.
This policy provides active checks. If you want to configure passive checks, please utilize the Circuit Breaker policy. Data plane proxies with active checks will explicitly send requests to other data plane proxies to determine if target proxies are healthy or not. This mode generates extra traffic to other proxies and services as described in the policy configuration.
As usual, we can apply
destinations selectors to determine how health-checks will be performed across our data plane proxies.
HealthCheck policy supports both L4/TCP (default) and L7/HTTP checks.
HTTP health checks are executed using HTTP 2
path - HTTP path which will be requested during the health checks
expectedStatuses (optional) - list of status codes which should be
considered as a healthy during the checks
- only statuses in the range
[100, 600) are allowed
- by default, when this property is not provided only responses with
200 are being considered healthy
requestHeadersToAdd (optional) - list of headers which should be
added to every health check request:
append (default, optional) - should the value of the provided
header be appended to already existing headers (if present)
key - the name of the header
value (optional) - the value of the header
send - Base64 encoded content of the message which should be
sent during the health checks
receive list of Base64 encoded blocks of strings which should be
found in the returning message which should be considered as healthy
- when checking the response, “fuzzy” matching is performed such that
each block must be found, and in the order specified, but not
receive section won’t be provided or will be empty, checks
will be performed as “connect only” and will be marked as successful
when TCP connection will be successfully established.
HealthCheck is an Outbound Connection Policy.
The only supported value for