Warning

The v2 xDS API is not supported in Envoy v1.18.0 and above.

Health check logging events

Health check logging.

data.core.v2alpha.HealthCheckEvent

[data.core.v2alpha.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.v2alpha.HealthCheckerType)

host

(core.Address)

cluster_name

(string, REQUIRED)

eject_unhealthy_event

(data.core.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.HealthCheckEjectUnhealthy

[data.core.v2alpha.HealthCheckEjectUnhealthy proto]

{
  "failure_type": "..."
}
failure_type

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

data.core.v2alpha.HealthCheckAddHealthy

[data.core.v2alpha.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.v2alpha.HealthCheckFailure

[data.core.v2alpha.HealthCheckFailure proto]

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

(data.core.v2alpha.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.v2alpha.DegradedHealthyHost

[data.core.v2alpha.DegradedHealthyHost proto]

data.core.v2alpha.NoLongerDegradedHost

[data.core.v2alpha.NoLongerDegradedHost proto]

Enum data.core.v2alpha.HealthCheckFailureType

[data.core.v2alpha.HealthCheckFailureType proto]

ACTIVE

(DEFAULT)

PASSIVE

NETWORK

Enum data.core.v2alpha.HealthCheckerType

[data.core.v2alpha.HealthCheckerType proto]

HTTP

(DEFAULT)

TCP

GRPC

REDIS