Health Checks

By default, for a deployment to succeed, it must pass certain “health checks.”

If the Process does not expose a port it is considered healthy if it starts and doesn’t immediately exit or crash.

If the Process exposes a port is it considered healthy after it:

Common causes for not passing health checks are:

Health Check Options

services:
  web:
  health:
    grace: 5
    interval: 5
    path: /health
    timeout: 3
Label Notes
grace The amount of time to wait for a service to boot before beginning health checks.
interval The amount of time between health checks (default 5 seconds).
path The HTTP endpoint the load balancer will use to determine the application's health.
timeout The time in seconds after which no response means a failed health check (defaults to interval minus 1).

See also