Health Check

[Source]

The Health Check is a special peer port method for reporting on the health of an individual rippled server. This method is intended for use in automated monitoring to recognize outages and prompt automated or manual interventions such as restarting the server.

This method checks several metrics to see if they are in ranges generally considered healthy. If all metrics are in normal ranges, this method reports that the server is healthy. If any metric is outside normal ranges, this method reports that the server is unhealthy and reports the metric(s) that are unhealthy. Since some metrics may rapidly fluctuate into and out of unhealthy ranges, you should not raise alerts unless the health check fails multiple times in a row.

Note

Since the health check is a peer port method, it is not available when testing the server in stand-alone mode.

Request Format

To request the Health Check information, make the following HTTP request:

Protocol: https
HTTP Method: GET
Host: (any rippled server, by hostname or IP address)
Port: (the port number where the rippled server uses the Peer Protocol, typically 51235)
Path: /health
Security: Most rippled servers use a self-signed certificate to respond to the request. By default, most tools (including web browsers) flag or block such responses for being untrusted. You must ignore the certificate checking (for example, if using cURL, add the --insecure flag) to display a response from those servers.

Example Response

HTTP/1.1 200 OK
Server: rippled-1.6.0-b8
Content-Type: application/json
Connection: close
Transfer-Encoding: chunked

{
  "info": {}
}

Response Format

The response's HTTP status code indicates the health of the server:

Status Code	Health Status	Description
200 OK	Healthy	All health metrics are within acceptable ranges.
503 Service Unavailable	Warning	One or more metrics are in the warning range. Manual intervention may or may not be necessary.
500 Internal Server Error	Critical	One or more metrics are in the critical range. There is a serious problem that probably needs manual intervention to fix.

The response body is a JSON object with a single info object at the top level. The info object contains values for each metric that is in a warning or critical range. The response omits metrics that are in a healthy range, so a fully healthy server has an empty object.

The info object may contain the following fields:

`Field`	Value	Description
`amendment_blocked`	Boolean	(May be omitted) If `true`, the server is amendment blocked and must be upgraded to remain synced with the network; this state is critical. If the server is not amendment blocked, this field is omitted.
`load_factor`	Number	(May be omitted) A measure of the overall load the server is under. This reflects I/O, CPU, and memory limitations. This is a warning if the load factor is over 100, or critical if the load factor is 1000 or higher.
`peers`	Number	(May be omitted) The number of peer servers this server is connected to. This is a warning if connected to 7 or fewer peers, and critical if connected to zero peers.
`server_state`	String	(May be omitted) The current server state. This is a warning if the server is in the `tracking`, `syncing`, or `connected` states. This is critical if the server is in the `disconnected` state.
`validated_ledger`	Number	(May be omitted) The number of seconds since the last time a ledger was validated by consensus. If there is no validated ledger available (as during the initial sync period when starting the server), this is the value `-1` and is considered a warning. This metric is also a warning if the last validated ledger was at least 7 seconds ago, or critical if the last validated ledger was at least 20 seconds ago.

Health Check

Request Format

Example Response

Response Format

See Also