Nibiru oracle monitoring

This monitoring stack for nibiru network.

Prerequisites

We recommend to deploy monitoring stack on different machine, it requires low server resources, so any small VPS will be enough.

Used ports:

• 8080 (alertmanager-bot)
• 9090 (prometheus)
• 9093 (alertmanager)
• 9999 (grafana)

Dependencies installation

• Install git and curl on the server

sudo apt-get update && sudo apt-get install -y git curl

• Install docker as it's being needed to run monitoring stack

bash <(curl -s https://raw.githubusercontent.com/staketown/utils/main/docker-install.sh)

Check docker compose, output should be like this (ex. Docker Compose version v2.16.0)

docker compose version

Install monitoring stack

• Clone repository with monitoring stack to the server and prepare .evn file

git clone https://github.com/staketown/nibiru-oracle-monitoring.git nibiru-oracle-monitoring
cp $HOME/nibiru-oracle-monitoring/config/.env.example $HOME/nibiru-oracle-monitoring/config/.env

• Update values in .env file with your own

nano $HOME/nibiru-oracle-monitoring/config/.env

KEY	VALUE
TELEGRAM_ADMIN	Your user id you can get from @userinfobot. The bot will only reply to messages sent from the user. All other messages are dropped and logged on the bot's console
TELEGRAM_TOKEN	Your telegram bot access token you can get from @botfather. To generate new token just follow a few simple steps described here
NIBIRU_GRPC	Your nibiru's grpc endpoint

• Export .env file values into .bash_profile

echo "export $(xargs < $HOME/nibiru-oracle-monitoring/config/.env)" >> $HOME/.bash_profile
source $HOME/.bash_profile

• Install yq to perform next action

sudo wget -qO /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64
sudo chmod a+x /usr/local/bin/yq

• Replce YOUR_VALOPER_ADDRESS with you validator address value and execute command

VALOPER=YOUR_VALOPER_ADDRESS yq -i '.scrape_configs[1].static_configs[0].labels.valoper = strenv(VALOPER)' ~/nibiru-oracle-monitoring/prometheus/prometheus.yml
MONIKER=YOUR_VALOPER_MONIKER yq -i '.scrape_configs[1].static_configs[0].labels.instance = strenv(MONIKER)' ~/nibiru-oracle-monitoring/prometheus/prometheus.yml

Support several validators

Dashboard supports monitoring of several validators, to do that you just need to open from working directory ./prometheus/prometheus.yml and set one more config entity. It should be looked like below:

Start monitoring

• Deploy the monitoring stack

cd $HOME/nibiru-oracle-monitoring && docker compose up -d

Dashboard content

Grafana dashboard has static oracle on-chain configuration and dynamic those are being retrieved and calculated over exporter

Cleanup all container data

cd $HOME/nibiru-oracle-monitoring && docker compose down && docker volume prune -f

Reference list

• Stack of monitoring tools node_tooling by Xiphiar
• Alert manager telegram bot alertmanager-bot by metalmatze

Contribution

Just submit PR if you see any issues, we would appreciate it!