Health check

  • Health check filter architecture overview

  • This filter should be configured with the type URL type.googleapis.com/envoy.extensions.filters.http.health_check.v3.HealthCheck.

  • v3 API reference

Note

Note that the filter will automatically fail health checks and set the x-envoy-immediate-health-check-fail header on all responses (both health check and normal requests) if the /healthcheck/fail admin endpoint has been called. (The /healthcheck/ok admin endpoint reverses this behavior).

Statistics

The health check filter outputs statistics in the http.<stat_prefix>.health_check. namespace. The stat prefix comes from the owning HTTP connection manager.

Name

Type

Description

request_total

Counter

Total number of requests processed by this health check filter ()including responses served from the cache)

failed

Counter

Total number of health checks that failed (including failures due to cluster status and responses served from the cache)

ok

Counter

Total number of health checks that passed

cached_response

Counter

Total number of requests that were responded to with cached health check status

failed_cluster_not_found

Counter

Total number of failed health checks due to referenced cluster not being found

failed_cluster_empty

Counter

Total number of failed health checks due to empty cluster membership when checking cluster health

failed_cluster_unhealthy

Counter

Total number of failed health checks due to cluster falling below minimum healthy percentage threshold

degraded

Counter

Total number of health check responses that reported degraded status