Edit content

Health Endpoint

RoadRunner server includes a health check endpoint that returns the health of the workers.

Enable health

To enable the health check endpoint, add a status section to your configuration:

version: "2.7"

status:
  address: localhost:2114

To access the health-check use the following URL:

http://localhost:2114/health?plugin=http

You can check one or multiple plugins using health-check. Currently, only HTTP supported.

Once enabled, the health check endpoint will respond with the following:

  • HTTP 200 if there is at least one worker ready to serve requests.
  • HTTP 500 if there are no workers ready to service requests.

Use cases

The health check endpoint can be used for the following: