package healthchecker

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: HealthCheckerAttributes

• string query_string = 1

  dns query string (".", "www.dropbox.com" and etc)

• DnsCheckerAttributes.DNSQueryType query_type = 2

  type of dns query message.

• IPProtocol protocol = 3

  dns client (tcp|udp) transport.

• uint32 rcode = 4

  expected rcode in response to path health check.

• uint32 check_timeout_ms = 10

  max wait timeout in milliseconds to complete the test. default value is 5000 ms.

Used in: DnsCheckerAttributes

• A = 0

  IPv4 address record.

• AAAA = 1

  IPv6 address record.

• NS = 2

  Name server record.

• MX = 3

  Mail exchange record.

• TXT = 4

  Text record.

• SOA = 5

  Start of authority record.

Used in: HealthCheckerAttributes

(message has no fields)

Used in: UpstreamChecker

• oneof attributes

  • DummyCheckerAttributes dummy = 1

  • DnsCheckerAttributes dns = 2

  • HttpCheckerAttributes http = 3

  • SyslogCheckerAttributes syslog = 4

  • TcpCheckerAttributes tcp = 5

Used in: HealthCheckerAttributes

• string scheme = 1

  http or https perform https request to backend if set to 'https'

• string uri = 2

  TODO(team): rename to urlPath or something same url path to be requested on backend: "/", "/health", etc.

• map<string, string> headers = 3

  headers to be set in http request

• repeated uint32 codes = 4

  list of expected http response codes

• string proxy_check_url = 5

  if `proxy_check_url` is defined, healthcheck is performed as http[s] (based on `scheme` field) proxy request to backend querying `proxy_check_url`, `uri` is ignored.

• bool follow_redirects = 6

  follow redirects and latest response code, disabled by default

• uint32 check_timeout_ms = 10

  max wait timeout in milliseconds to complete the test. default value is 5000 ms.

Used in: DnsCheckerAttributes, SyslogCheckerAttributes

• TCP = 0

• UDP = 1

Configuration of syslog health checker.

Used in: HealthCheckerAttributes

• uint32 log_level = 1

  Syslog log level specified in the message sent to syslog daemon.

• uint32 port = 2

  (Optional) Health checking port. When it's specified (has positive value) health checker will use the number as dst port instead of using port defined in lb_service config.

• IPProtocol protocol = 3

  tcp|udp health checking transport. It might be helpful to perform health checking over tcp even lb_service is udp since udp health checking is not much effective without any response from syslog daemon.

• uint32 check_timeout_ms = 10

  max wait timeout in milliseconds to complete the test. default value is 5000 ms.

Configuration of TCP health checker

Used in: HealthCheckerAttributes

• uint32 check_timeout_ms = 1

  max wait timeout in milliseconds to complete the test default value is 5000ms

Used in: kglb.BalancerConfig

• uint32 interval_ms = 2

  individual entry check interval

• uint32 rise_count = 3

  number of consecutive valid health checks before considering the upstream as UP

• uint32 fall_count = 4

  number of consecutive invalid health checks before considering the upstream as DOWN

• optional HealthCheckerAttributes checker = 5

• uint32 concurrency_limit = 6

  How many concurrency health checks can be send to this set of upstreams. Default value is 100.