data-plane-api/api/health_check.proto

syntax = "proto3";

package envoy.api.v2;

import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";

message HealthCheck {
  // The time to wait for a health check response. If the timeout is reached the
  // health check attempt will be considered a failure.
  google.protobuf.Duration timeout = 1;
  // The interval between health checks.
  google.protobuf.Duration interval = 2;
  // An optional jitter amount in millseconds. If specified, during every
  // internal Envoy will add 0 to interval_jitter to the wait time.
  google.protobuf.Duration interval_jitter = 3;

  // 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.
  google.protobuf.UInt32Value unhealthy_threshold = 4;
  // 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.
  google.protobuf.UInt32Value healthy_threshold = 5;

  // Non-serving port for health checking.
  google.protobuf.UInt32Value alt_port = 6;
  // Reuse health check connection between health checks. Default is true.
  google.protobuf.BoolValue reuse_connection = 7;

  // The Envoy HTTP health checker supports the service_name option. If this
  // option is set, the health checker additionally compares the value of the
  // x-envoy-upstream-healthchecked-cluster response header to service_name. If
  // the values do not match, the health check does not pass. The upstream
  // health check filter appends x-envoy-upstream-healthchecked-cluster to the
  // response headers. The appended value is determined by the --service-cluster
  // command line option.
  string service_name = 8;

  // Describes the encoding of the payload bytes in the payload
  message Payload {
    oneof payload {
      string text = 1;
      bytes binary = 2;
    }
  }
  message HttpHealthCheck {
    // The value of the host header in the HTTPS health check request. If left
    // empty (default value), the IP on behalf of which this health check is
    // performed will be used.
    string host = 1;
    // This parameter is required if the type is http. It species the HTTP path
    // that will be requested during health checking. For example /healthcheck.
    string path = 2;
    Payload send = 3;
    Payload receive = 4;
  }
  message TcpHealthCheck {
    // Empty payloads imply a connect-only health check.
    Payload send = 1;
    // When checking the response, “fuzzy” matching is performed such that each
    // binary block must be found, and in the order specified, but not
    // necessarly contiguous.
    repeated Payload receive = 2;
  }
  message RedisHealthCheck {
  }
  oneof health_checker {
    HttpHealthCheck http_health_check = 9;
    TcpHealthCheck tcp_health_check = 10;
    RedisHealthCheck redis_health_check = 11;
  }
}

enum HealthStatus {
  // UNKNOWN should be treated by Envoy as HEALTHY.
  UNKNOWN = 0;
  HEALTHY = 1;
  UNHEALTHY = 2;
  // Connection draining in progress -
  // https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/
  // and
  // https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining.
  DRAINING = 3;
  // This value is used by HDS Remote server. From Envoy’s perspective
  // TIMEOUT = UNHEALTHY in case EDS returns HealthStatus.
  TIMEOUT = 4;
}