This guide covers how to monitor your Shibarium nodes using official telemetry tools for both Heimdall and Bor. Proper monitoring ensures node health, uptime, and quick troubleshooting.

​
Overview

  • Heimdall Telemetry: Monitor Heimdall node status and metrics on Shibarium and Puppynet.
  • Bor EthStat: Monitor Bor node status and metrics on Shibarium and Puppynet.

​
Heimdall Telemetry Setup

1

Clone the Telemetry Repository and Set Up Configuration

git clone https://github.com/shibaone/k9-matic-telemetry.gitcd k9-matic-telemetrymkdir -p ~/.telemetry/configcp example.config.toml ~/.telemetry/config/config.toml
2

Update the Configuration File

Edit ~/.telemetry/config/config.toml and update the [stats_details] section:For Shibarium:
[stats_details]
secret_key = "heimdall_shibarium"
node = "<node-name>"
net_stats_ip = "shibarium-heimdall-ethstat.shib.io:443"
retry_delay = "250ms"
For Puppynet:
[stats_details]
secret_key = "heimdall_puppynet"
node = "<node-name>"
net_stats_ip = "puppynet-heimdall-ethstat.shib.io:443"
retry_delay = "250ms"
Replace <node-name> with your node’s name.
3

Build the Telemetry Binary

go mod tidygo build -o telemetrymv telemetry $GOBIN
4

Create a Systemd Service

Create /lib/systemd/system/telemetry.service with:
[Unit]
Description=Telemetry
After=network-online.target

[Service]
User=$USER
ExecStart=$(which telemetry)
Restart=always
RestartSec=3
LimitNOFILE=4096

[Install]
WantedBy=multi-user.target
Double-check the User and ExecStart fields for accuracy.
5

Start and Enable the Telemetry Service

sudo systemctl enable telemetry.servicesudo systemctl start telemetry.service
6

Monitor the Service

journalctl -u telemetry -f
7

Verify Node Visibility

Check your node on:

​
Bor EthStat Setup

1

Edit the Bor Configuration File

vi /var/lib/bor/config.toml Add the following line for telemetry: For Shibarium: ethstats = “<node>:[email protected]”
Double-check the ethstats entry for accuracy.
2

Restart and Enable Bor Service

sudo systemctl restart bor.service
3

Verify Your Node on the Monitoring Page

​
Best Practices

  • Always monitor both Heimdall and Bor nodes for uptime and health.
  • Use descriptive node names for easy identification.
  • Regularly check logs and monitoring dashboards.
  • Keep your telemetry and node software up to date.