Set up Monitoring using the RadixNode CLI

Introduction

RadixDLT uses Prometheus and Grafana to provide nodes with a real-time monitoring and alert system. A custom-built exporter extracts metrics from the node and sends it Prometheus which stores it as into the time series data. Grafana reads this time series information and uses it to build monitoring dashboards for displaying node information and alerts in real-time.

Diagram

The Exporter/Prometheus/Grafana installation has been packaged as part of the radixnode script. This will allow node runners to get a monitoring dashboard up and running by simply running the script and answering a few questions.

This setup runs the monitor on the same machine as the node. In the near future we will offer a cloud-based installation that will have less of an impact on the node in terms of maintenance and resource usage.

Prerequisites

It probably goes without saying that before you can install the node monitoring software, you must have a node up and running. If you haven’t, then run through one of our guides which will show you how to do it. We have separate instructions for installing a Docker node and installing a Standalone node.

So before you start you must have the radixnode script in place, and an installed node.

1. Set up the monitoring service

The monitoring instance uses port 3000 on your server, so make sure that this port is open and available for Grafana to use.

If you are running a standalone node then you must first change to the radixdlt user:

Only run this command if you’re operating a standalone node.
sudo su - radixdlt

This is not required if you’re running a Docker node.

Now you can run the script to set up monitoring:

radixnode setup-monitoring
finished monitoring installation
Finishing the monitor installation

And that’s pretty much it.

2. Accessing the dashboard.

You can view your node’s dashboard remotely using any browser, using this URL pattern:

http://<node-ip-address>:3000/d/radix_node_dashboard/radix-node-dashboard?orgId=1&refresh=5s

The node-ip-address is the external IP address your node’s server.

Grafana will display a page asking for your username and password.

log into grafana
Enter admin and admin for the username and password

Since this is the first time you’ve run the monitor, enter admin for the username and admin again for the password. Grafana will now display another dialog asking you to change the password for the admin user. (Again, this is because this is the first time you’ve logged into the monitoring service.)

Grafana will now display your dashboard:

single node dashboard image
The Grafana dashboard

3. Shut down Node monitoring

If you’re shutting down the monitor for a Standalone node, then you’ll first need to sign in as the radixdlt user before issuing the shutdown command:

Only execute this command if you installed your node as a Standalone instance.
sudo su - radixdlt

Then, to shut down the monitor, use the following command:

radixnode stop-monitoring