Health check logging events

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:

data/core/v2alpha/health_check_event.proto

Health check logging.

data.core.v3.HealthCheckEvent

[data.core.v3.HealthCheckEvent proto]

{
  "health_checker_type": "...",
  "host": "{...}",
  "cluster_name": "...",
  "eject_unhealthy_event": "{...}",
  "add_healthy_event": "{...}",
  "health_check_failure_event": "{...}",
  "degraded_healthy_host": "{...}",
  "no_longer_degraded_host": "{...}",
  "timestamp": "{...}"
}

health_checker_type

(data.core.v3.HealthCheckerType)

host

(config.core.v3.Address)

cluster_name

(string, REQUIRED)

eject_unhealthy_event

(data.core.v3.HealthCheckEjectUnhealthy) Host ejection.

Precisely one of eject_unhealthy_event, add_healthy_event, health_check_failure_event, degraded_healthy_host, no_longer_degraded_host must be set.

add_healthy_event

(data.core.v3.HealthCheckAddHealthy) Host addition.

Precisely one of eject_unhealthy_event, add_healthy_event, health_check_failure_event, degraded_healthy_host, no_longer_degraded_host must be set.

health_check_failure_event

(data.core.v3.HealthCheckFailure) Host failure.

Precisely one of eject_unhealthy_event, add_healthy_event, health_check_failure_event, degraded_healthy_host, no_longer_degraded_host must be set.

degraded_healthy_host

(data.core.v3.DegradedHealthyHost) Healthy host became degraded.

Precisely one of eject_unhealthy_event, add_healthy_event, health_check_failure_event, degraded_healthy_host, no_longer_degraded_host must be set.

no_longer_degraded_host

(data.core.v3.NoLongerDegradedHost) A degraded host returned to being healthy.

Precisely one of eject_unhealthy_event, add_healthy_event, health_check_failure_event, degraded_healthy_host, no_longer_degraded_host must be set.

timestamp

(Timestamp) Timestamp for event.

data.core.v3.HealthCheckEjectUnhealthy

[data.core.v3.HealthCheckEjectUnhealthy proto]

{
  "failure_type": "..."
}

failure_type

(data.core.v3.HealthCheckFailureType) The type of failure that caused this ejection.

data.core.v3.HealthCheckAddHealthy

[data.core.v3.HealthCheckAddHealthy proto]

{
  "first_check": "..."
}

first_check

(bool) Whether this addition is the result of the first ever health check on a host, in which case the configured healthy threshold is bypassed and the host is immediately added.

data.core.v3.HealthCheckFailure

[data.core.v3.HealthCheckFailure proto]

{
  "failure_type": "...",
  "first_check": "..."
}

failure_type

(data.core.v3.HealthCheckFailureType) The type of failure that caused this event.

first_check

(bool) Whether this event is the result of the first ever health check on a host.

data.core.v3.DegradedHealthyHost

[data.core.v3.DegradedHealthyHost proto]

data.core.v3.NoLongerDegradedHost

[data.core.v3.NoLongerDegradedHost proto]

Enum data.core.v3.HealthCheckFailureType

[data.core.v3.HealthCheckFailureType proto]

ACTIVE

(DEFAULT) ⁣

PASSIVE

⁣

NETWORK

⁣

NETWORK_TIMEOUT

⁣

Enum data.core.v3.HealthCheckerType

[data.core.v3.HealthCheckerType proto]

HTTP

(DEFAULT) ⁣

TCP

⁣

GRPC

⁣

REDIS

⁣