Matic-stats-exporter

• Bor:-

Telemetry data for Bor nodes on Mainnet and Mumbai-testnet can be found here https://bor-mainnet.vitwit.com and https://bor-mumbai.vitwit.com.

To export your nodes telemetry data to these dashboards do the following steps -

Restart your bor node with the ethstats flag

• Add --ethstats flag to your bor bash script which will be present at ~/node/bor/start.sh. After adding the flag to the bash file it should look like this:

set -x #echo on

BOR_DIR=${BOR_DIR:-~/.bor}
DATA_DIR=$BOR_DIR/data

bor --datadir $DATA_DIR \
--ethstats <node-name>:<key>@<server-ip>:<port> \
--port 30303 \
--http --http.addr '0.0.0.0' \
--http.vhosts '*' \
--http.corsdomain '*' \
......
......

Note:- For connecting to the mainnet dashboard use --ethstats <node-name>:mainnet@bor-mainnet.vitwit.com:3000. For connecting to the testnet dashboard use --ethstats <node-name>:testnet@bor-mumbai.vitwit.com:3000. <node-name> is just an identifier to display it on the dashboard.

• Restart your bor service sudo systemctl restart bor

To set up your own dashboard follow these instructions.

• Heimdall:-

Telemetry data for Heimdall nodes on Mainnet and Amoy-testnet can be found here mainnet.conspulse.com/ and https://testnet.conspulse.com/

To export your nodes telemetry data to these dashboards do the following:-

git clone https://github.com/vitwit/matic-telemetry.git
cd matic-telemetry
git checkout v0.1.4
mkdir -p ~/.telemetry/config
cp example.config.toml ~/.telemetry/config/config.toml

Replace default value of node with your in ~/.telemetry/config/config.toml.

Use the following secret_key and url to connect to Mainnet dashboard

[stats_details]
secret_key = "mainnet-conspulse"
node = "<node-name>"
stats_service_url = "https://api.mainnet.conspulse.com"

Use the following secret_key and url to connect to Testnet dashboard

[stats_details]
secret_key = "testnet-conspulse"
node = "<node-name>"
stats_service_url = "https://api.testnet.conspulse.com"

Build the binary :-

go build -o telemetry
mv telemetry $GOBIN

Create systemd file :-

echo "[Unit]
Description=Telemtry
After=network-online.target
[Service]
User=$USER
ExecStart=$(which telemetry)
Restart=always
RestartSec=3
LimitNOFILE=4096
[Install]
WantedBy=multi-user.target" | sudo tee "/etc/systemd/system/telemetry.service"

Start the telemetry service

sudo systemctl enable telemetry.service
sudo systemctl start telemetry.service

View the logs using

journalctl -u telemetry -f

Migrating from Heimdall eth-netstats to conspulse

If you were already running matic-telemetry and exporting heimdall telemetry data to eth-netstats dashboard then follow these instructions to start exporting your telemetry metrics to conspulse dashboard:

1. Stop the telemetry service:

sudo systemctl stop telemetry.service

2. Delete the previous telemetry config file:

rm ~/.telemetry/config/config.toml

3. Build the new telemetry binary:

git clone https://github.com/vitwit/matic-telemetry.git
cd matic-telemetry
git checkout v0.1.4
mkdir -p ~/.telemetry/config
cp example.config.toml ~/.telemetry/config/config.toml
go build -o telemetry

4. Replace the old binary in your $GOBIN:

mv telemetry $GOBIN

5. Edit telemetry config file to connect to conspulse:

Use the following secret_key and url to connect to Mainnet dashboard

[stats_details]
secret_key = "mainnet-conspulse"
node = "<node-name>"
stats_service_url = "https://api.mainnet.conspulse.com"

Use the following secret_key and url to connect to Testnet dashboard

[stats_details]
secret_key = "testnet-conspulse"
node = "<node-name>"
stats_service_url = "https://api.testnet.conspulse.com"

6. Restart the telemetry systemd service:

sudo systemctl restart telemetry.service

After these steps, your telemetry exporter will be compatible with the new conspulse dashboard.