Monitoring node's health

Radix node provides the System API that can be used to monitor its health.

You can query your own node at these endpoints to get various kinds of data about the the operation of the node. The easiest way to call the endpoints is through the babylonnode script (see Installing the babylonnode CLI for more information), but you can also use curl, for example.

The /health endpoint

The most basic check on your node’s health is ensuring that it is running and syncing with the network. This is what the /health endpoint is used for. Execute the following command to check the status of your node:

babylonnode api system health

curl -k -u admin:nginx-password "https://localhost/system/health"

The call returns a simple status message that is easy to check and monitor, like this:

{
  "status": "UP",
  ...
}

The status message will be one of the following codes:

• BOOTING_PRE_GENESIS the node is booting and not ready to accept requests

• SYNCING the node is catching up the network

• UP the node is in sync with consensus

• OUT_OF_SYNC the node is out of sync

Refer to Health and Metrics documentation for more details on monitoring node’s health.

The /prometheus/metrics endpoint

The /metrics endpoint provides a wealth of performance and operational data. While it can be queried directly, it is designed for use with monitoring and alerting dashboards, such as Grafana, and so provides its data in the Prometheus data format.

Radix provides a convenient Grafana monitoring dashboard installation through the babylonnode CLI.