Health check

Health check configuration overview.

config.filter.http.health_check.v2.HealthCheck

[config.filter.http.health_check.v2.HealthCheck proto]

{
  "pass_through_mode": "{...}",
  "endpoint": "...",
  "cache_time": "{...}",
  "cluster_min_healthy_percentages": "{...}"
}

pass_through_mode

(BoolValue, REQUIRED) Specifies whether the filter operates in pass through mode or not.

endpoint

(string, REQUIRED) Specifies the incoming HTTP endpoint that should be considered the health check endpoint. For example /healthcheck.

cache_time

(Duration) If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.

cluster_min_healthy_percentages

(map<string, type.Percent>) If operating in non-pass-through mode, specifies a set of upstream cluster names and the minimum percentage of servers in each of those clusters that must be healthy in order for the filter to return a 200.