Skip to main content

8.1 Software Preparation

Node monitoring ensures that operators can solve issues ahead of time, maintain uptime, and optimize performance by providing real-time insight into system health, client status, and network usage. This page will walk you through the software installs and configurations needed to get your monitoring environment up and running. All the monitoring tooling, regardless of the client configurations, generally follows a modular approach of software modules.

StepNameDescription
1Install Core Tools & Port ConfigurationInstall required packages and expose monitoring ports.
2Create Exporter ServicesExport metrics like system, consensus, and execution data.
3Setup PrometheusScrape and process metrics from exporter services.
4Configure GrafanaVisualizing metrics and creating dashboards.
5Configure DashboardLoad dashboards and configure alerts.
tip

Further details about node analytics can be found on the Monitoring Tools page in the 🧠 Theory section.

info

As the table suggests, exporter services and clients should be set up before configuring Prometheus or Grafana, so all data sources are set in place. Setting up the underlaying software first has the following benefits:

  • Problem Encapsulation: By installing exporters beforehand, you can verify that the metrics are accessible and correctly exposed. Separated installation helps troubleshoot potential issues with the exporters or the services themselves.
  • No Idle Rotation Problems: With the exporters already installed and configured, Prometheus can immediately start scraping the endpoints and collecting metrics. Having data endpoints running ensures that you have data available for monitoring as soon as Prometheus is up, excluding errors where configurations need to be reloaded and updated.

The LUKSO CLI does not restrict the use of additional tools and monitoring solutions, but it also doesn’t include any monitoring tools out of the box. That means the setup must be done manually and will dock onto the already running clients. The following six tools are essential to install before setting up Prometheus, Grafana, and the required Exporters:

ToolDescription
wget Utility for downloading files to fetch resources directly from the terminal.
make Automation tool used to compile software, required for compiling some exporter tools.
git Version control system used to clone repositories for exporter services.
apt-transport-https Allows to securely download packages over HTTPS, required for third-party software.
software-properties-common Provides useful tools like add-apt-repository to manage software sources.
gnupg2 Standard for secure encryption and signing, required for verifying package signatures.
info

The following step is performed on your 📟 node server.

sudo apt install wget make git apt-transport-https software-properties-common gnupg2