Health Check

Reports whether the API and its modules (Chromium, LibreOffice) are healthy. Use it for Kubernetes liveness probes or monitoring agents.

A module going through a planned restart, after CHROMIUM_RESTART_AFTER or LIBREOFFICE_RESTART_AFTER conversions, still reports healthy: requests arriving meanwhile wait for the new process instead of failing. An unplanned restart, after a crash or a failed probe, reports unhealthy.

Basics

GET/health

Headers

Gotenberg-Tracestring

A custom request ID to identify the request in the logs; overrides the default UUID.

Example Request

cURL

curl --request GET http://localhost:3000/health

Responses

200

The service is healthy.

{
  status: "up",
  details: {
    chromium: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
    libreoffice: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
  },
}

503

The service is unhealthy.

{
  status: "down",
  details: {
    chromium: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
    libreoffice: {
      status: "down",
      timestamp: "2021-07-01T08:05:14.603364Z",
      error: "LibreOffice is unhealthy",
    },
  },
}

What's Next?

Probe without a response body using the HEAD health check, or scrape runtime metrics with Prometheus.