status/schema.json at master · roadrunner-server/status · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "$id": "https://raw.githubusercontent.com/roadrunner-server/status/refs/heads/master/schema.json",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "description": "All the valid configuration parameters for the Health Check (Status) plugin for RoadRunner.",
  "type": "object",
  "title": "roadrunner-status",
  "additionalProperties": false,
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "description": "Host and port to listen on (eg.: `127.0.0.1:2114`). To query a plugin, pass its name as a query parameter called `plugin`, e.g. to check the `http` plugin, request `GET http://127.0.0.1:2114/health?plugin=http`. You can query multiple plugins by appending multiple instances of the `plugin` parameter, e.g. `GET http://127.0.0.1:2114/health?plugin=http&plugin=rpc`.",
      "type": "string",
      "minLength": 1,
      "examples": [
        "127.0.0.1:2114"
      ]
    },
    "unavailable_status_code": {
      "description": "Response HTTP status code returned when a requested plugin is unavailable, and by /ready and /jobs during graceful shutdown. Valid for the /health, /ready, and /jobs endpoints (the /health liveness probe still returns 200 during shutdown). Defaults to 503 if undefined or zero.",
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "default": 503
    },
    "check_timeout": {
      "description": "The maximum duration to wait for a complete response from the queried plugin(s), in seconds. Defaults to 60.",
      "type": "integer",
      "minimum": 1,
      "default": 60
    }
  }
}