.. _envoy_api_file_envoy/data/core/v2alpha/health_check_event.proto: Health check logging events =========================== :ref:`Health check logging `. .. _envoy_api_msg_data.core.v2alpha.HealthCheckEvent: data.core.v2alpha.HealthCheckEvent ---------------------------------- `[data.core.v2alpha.HealthCheckEvent proto] `_ .. code-block:: json { "health_checker_type": "...", "host": "{...}", "cluster_name": "...", "eject_unhealthy_event": "{...}", "add_healthy_event": "{...}", "health_check_failure_event": "{...}", "degraded_healthy_host": "{...}", "no_longer_degraded_host": "{...}", "timestamp": "{...}" } .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.health_checker_type: health_checker_type (:ref:`data.core.v2alpha.HealthCheckerType `) .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.host: host (:ref:`core.Address `) .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.cluster_name: cluster_name (`string `_, *REQUIRED*) .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.eject_unhealthy_event: eject_unhealthy_event (:ref:`data.core.v2alpha.HealthCheckEjectUnhealthy `) Host ejection. Precisely one of :ref:`eject_unhealthy_event `, :ref:`add_healthy_event `, :ref:`health_check_failure_event `, :ref:`degraded_healthy_host `, :ref:`no_longer_degraded_host ` must be set. .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.add_healthy_event: add_healthy_event (:ref:`data.core.v2alpha.HealthCheckAddHealthy `) Host addition. Precisely one of :ref:`eject_unhealthy_event `, :ref:`add_healthy_event `, :ref:`health_check_failure_event `, :ref:`degraded_healthy_host `, :ref:`no_longer_degraded_host ` must be set. .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.health_check_failure_event: health_check_failure_event (:ref:`data.core.v2alpha.HealthCheckFailure `) Host failure. Precisely one of :ref:`eject_unhealthy_event `, :ref:`add_healthy_event `, :ref:`health_check_failure_event `, :ref:`degraded_healthy_host `, :ref:`no_longer_degraded_host ` must be set. .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.degraded_healthy_host: degraded_healthy_host (:ref:`data.core.v2alpha.DegradedHealthyHost `) Healthy host became degraded. Precisely one of :ref:`eject_unhealthy_event `, :ref:`add_healthy_event `, :ref:`health_check_failure_event `, :ref:`degraded_healthy_host `, :ref:`no_longer_degraded_host ` must be set. .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.no_longer_degraded_host: no_longer_degraded_host (:ref:`data.core.v2alpha.NoLongerDegradedHost `) A degraded host returned to being healthy. Precisely one of :ref:`eject_unhealthy_event `, :ref:`add_healthy_event `, :ref:`health_check_failure_event `, :ref:`degraded_healthy_host `, :ref:`no_longer_degraded_host ` must be set. .. _envoy_api_field_data.core.v2alpha.HealthCheckEvent.timestamp: timestamp (`Timestamp `_) Timestamp for event. .. _envoy_api_msg_data.core.v2alpha.HealthCheckEjectUnhealthy: data.core.v2alpha.HealthCheckEjectUnhealthy ------------------------------------------- `[data.core.v2alpha.HealthCheckEjectUnhealthy proto] `_ .. code-block:: json { "failure_type": "..." } .. _envoy_api_field_data.core.v2alpha.HealthCheckEjectUnhealthy.failure_type: failure_type (:ref:`data.core.v2alpha.HealthCheckFailureType `) The type of failure that caused this ejection. .. _envoy_api_msg_data.core.v2alpha.HealthCheckAddHealthy: data.core.v2alpha.HealthCheckAddHealthy --------------------------------------- `[data.core.v2alpha.HealthCheckAddHealthy proto] `_ .. code-block:: json { "first_check": "..." } .. _envoy_api_field_data.core.v2alpha.HealthCheckAddHealthy.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 :ref:`healthy threshold ` is bypassed and the host is immediately added. .. _envoy_api_msg_data.core.v2alpha.HealthCheckFailure: data.core.v2alpha.HealthCheckFailure ------------------------------------ `[data.core.v2alpha.HealthCheckFailure proto] `_ .. code-block:: json { "failure_type": "...", "first_check": "..." } .. _envoy_api_field_data.core.v2alpha.HealthCheckFailure.failure_type: failure_type (:ref:`data.core.v2alpha.HealthCheckFailureType `) The type of failure that caused this event. .. _envoy_api_field_data.core.v2alpha.HealthCheckFailure.first_check: first_check (`bool `_) Whether this event is the result of the first ever health check on a host. .. _envoy_api_msg_data.core.v2alpha.DegradedHealthyHost: data.core.v2alpha.DegradedHealthyHost ------------------------------------- `[data.core.v2alpha.DegradedHealthyHost proto] `_ .. code-block:: json {} .. _envoy_api_msg_data.core.v2alpha.NoLongerDegradedHost: data.core.v2alpha.NoLongerDegradedHost -------------------------------------- `[data.core.v2alpha.NoLongerDegradedHost proto] `_ .. code-block:: json {} .. _envoy_api_enum_data.core.v2alpha.HealthCheckFailureType: Enum data.core.v2alpha.HealthCheckFailureType --------------------------------------------- `[data.core.v2alpha.HealthCheckFailureType proto] `_ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckFailureType.ACTIVE: ACTIVE *(DEFAULT)* ⁣ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckFailureType.PASSIVE: PASSIVE ⁣ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckFailureType.NETWORK: NETWORK ⁣ .. _envoy_api_enum_data.core.v2alpha.HealthCheckerType: Enum data.core.v2alpha.HealthCheckerType ---------------------------------------- `[data.core.v2alpha.HealthCheckerType proto] `_ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckerType.HTTP: HTTP *(DEFAULT)* ⁣ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckerType.TCP: TCP ⁣ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckerType.GRPC: GRPC ⁣ .. _envoy_api_enum_value_data.core.v2alpha.HealthCheckerType.REDIS: REDIS ⁣