Skip to content
GuvDocs

services.<name>.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”
services:
  web:
    healthcheck: /healthz
services:
  web:
    healthcheck:
      path: /healthz
      timeout: 10s

Fields

Section titled “Fields”

type

Section titled “type”

services.<name>.healthcheck.type

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

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

path

Section titled “path”

services.<name>.healthcheck.path

Path for HTTP checks.

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

port

Section titled “port”

services.<name>.healthcheck.port

Port to check; defaults to the service port.

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

timeout

Section titled “timeout”

services.<name>.healthcheck.timeout

Per-check timeout (up to 60s).

services:
  web:
    healthcheck:
      timeout: 10s

interval

Section titled “interval”

services.<name>.healthcheck.interval

Time between checks.

services:
  web:
    healthcheck:
      interval: 10s

start_timeout

Section titled “start_timeout”

services.<name>.healthcheck.start_timeout

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

services:
  web:
    healthcheck:
      start_timeout: 5m

See also

Section titled “See also”