Skip to content
GuvDocs

defaults.healthcheck

View as Markdown

How Guv decides a new deployment is healthy before moving traffic. A string is shorthand for an HTTP path.

  • Type: string or object
  • Since: manifest v1

Accepted forms

  • string
  • object: the full form, with the fields below

Example

Section titled “Example”
defaults:
  healthcheck: /healthz
defaults:
  healthcheck:
    path: /healthz
    timeout: 10s

Fields

Section titled “Fields”

type

Section titled “type”

defaults.healthcheck.type

HTTP GET expecting 2xx/3xx, or a TCP connect.

  • Type: http, tcp
  • Default: http
  • Since: manifest v1
defaults:
  healthcheck:
    type: http

path

Section titled “path”

defaults.healthcheck.path

Path for HTTP checks.

  • Type: string
  • Default: /
  • Pattern: ^/
  • Since: manifest v1
defaults:
  healthcheck:
    path: /healthz

port

Section titled “port”

defaults.healthcheck.port

Port to check; defaults to the service port.

  • Type: integer
  • Range: 1 to 65535
  • Since: manifest v1
defaults:
  healthcheck:
    port: 3000

timeout

Section titled “timeout”

defaults.healthcheck.timeout

Per-check timeout (up to 60s).

defaults:
  healthcheck:
    timeout: 10s

interval

Section titled “interval”

defaults.healthcheck.interval

Time between checks.

defaults:
  healthcheck:
    interval: 10s

start_timeout

Section titled “start_timeout”

defaults.healthcheck.start_timeout

How long a new deployment has to become healthy (up to 15m).

defaults:
  healthcheck:
    start_timeout: 5m

See also

Section titled “See also”