Health check

    • If health checking is configured for a cluster, additional statistics are emitted. They are documented here.

    timeout

    () The time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure.

    interval

    (Duration) The interval between health checks.

    interval_jitter

    () An optional jitter amount in millseconds. If specified, during every internal Envoy will add 0 to interval_jitter to the wait time.

    unhealthy_threshold

    (UInt32Value) The number of unhealthy health checks required before a host is marked unhealthy. Note that for http health checking if a host responds with 503 this threshold is ignored and the host is considered unhealthy immediately.

    healthy_threshold

    () The number of healthy health checks required before a host is marked healthy. Note that during startup, only a single successful health check is required to mark a host healthy.

    reuse_connection

    http_health_check

    (HealthCheck.HttpHealthCheck) HTTP health check.

    Precisely one of , tcp_health_check, must be set.

    tcp_health_check

    (HealthCheck.TcpHealthCheck) TCP health check.

    Precisely one of , tcp_health_check, must be set.

    redis_health_check

    (HealthCheck.RedisHealthCheck) Redis health check.

    Precisely one of , tcp_health_check, must be set.

    [HealthCheck.Payload proto]

    Describes the encoding of the payload bytes in the payload.

    (, REQUIRED) Hex encoded payload. E.g., “000000FF”.

    Precisely one of text must be set.

    path

    (string, REQUIRED) Specifies the HTTP path that will be requested during health checking. For example /healthcheck.

    service_name

    () An optional service name parameter which is used to validate the identity of the health checked cluster. See the architecture overview for more information.

    send

    (HealthCheck.Payload) Empty payloads imply a connect-only health check.

    receive