Loading repository data…
Loading repository data…
Cogwheel-Validator / repository
The Nibiru Oracle Monitor is a monitoring tool for the Nibiru Oracle. It monitors if the price feeder signed and wallet balances of the Nibiru Oracle, and alerts if any of these values are out of expected range. TNOM is written in Python, and the script can be compiled using Nuitka.
This project is no longer maintained as it is no longer needed.
The Nibiru Oracle Monitor is a monitoring tool for the Nibiru Oracle. It monitors if the price feeder signed and wallet balances of the Nibiru Oracle, and alerts if any of these values are out of the expected range. TNOM is written in Python, and the script can be compiled using Nuitka.
TNOM is a monitoring tool that collects data related to Nibiru's Oracle price feeder. The data is queried from the Nibiru REST API and stored in a SQLite database. If some parameters are out of the expected range, TNOM alerts the user, by Pagerduty or Telegram. As an addition features it has a dead man switch that can be triggered if the monitoring tool stops working. At the moment there is also a prometheus endpoint which can be used to send metrics from the SQLite database to Grafana or maybe you want to make your own alerting system.
It checks for the following parameters:
There are two ways to run TNOM:
The script was made with Poetry. You can use Poetry to install and run the script, use Python directly and run it like that, build the script using Nuitka, or download the compiled version.
Hardware and Operating System Requirements:
Minimum Requirements:
Recommended Requirements:
Software Requirements:
The script was made using Python 3.11 it should work with any version >= 3.11, it has been tested with 3.11 and 3.12.
Python Poetry was used to manage the dependencies. You can install it and use it to run the script, but it is not vital to run the script. It just simplifies the process. If you want to use Python Poetry, you can install it using the following command:
curl -sSL https://install.python-poetry.org | python3 -
If you plan to compile the code you will need to install patchelf, clang and some essential tools. To install it you can use the following command:
For Debian-based systems (Debian, Ubuntu, etc.):
sudo apt update
sudo apt install build-essential -y \
sudo apt install clang -y \
sudo apt install patchelf -y \
sudo apt install python-dev -y
For RHEL-based systems (Fedora, Rocky Linux, etc.):
sudo dnf update -y
sudo dnf groupinstall "Development Tools" -y
sudo dnf install clang -y
sudo dnf install patchelf -y
sudo dnf install python-devel -y
For this script to work you need to have:
The config.yml file is a file that stores data such as valoper address, interval check , APIs etc. Check the config_example.yml for an example. It should be an easy-to-edit yml file.
cp config_example.yml config.yml
vim config.yml # or nano config.yml
The alert config is a yml file that stores the alert details. It requires to have Pagerduty or Telegram details. You can also use both options if you desire. Some additional features are dead man switch and prometheus metrics endpoint. Dead man switch is a feature that can be triggered if the monitoring tool stops working. It is not a requriement but it is recommended to set it up.
cp alert_example.yml alert.yml
vim alert.yml # or nano alert.yml
For alert to work you will need at least a Telegram bot and chat ID, and for Pagerduty you will need a routing key from Events API v2. The alerts have multiple severity levels so you can set dynamic notifications. For the dead man switch you need to get link to your health check endpoint. Setting up telegram, pagerduty and health check is out of the scope of this guide. If there are many interested people, this section could be expanded a bit on that topic.Some links to get you started:
This is just a recommendation you can set up your TNOM however you wish. You can always set up everything in the project directory. And you can run the script/ binary from here.
Or you can create a dedicated directory and place everything there. This might make more sense if you plan to run it via Docker for example.
The script can accept arguments that can be passed to by using the command line. You can print help if you feel stuck.
poetry run python tnom/main.py -h # or python tnom/main.py --help
# or build/tnom -h if you built executable binary
usage: main.py [-h] [--working-dir WORKING_DIR] [--config-path CONFIG_PATH]
[--alert-path ALERT_PATH] [--version]
[--prometheus-host PROMETHEUS_HOST]
[--prometheus-port PROMETHEUS_PORT]
Monitoring tool for tracking Nibiru Oracle
options:
-h, --help show this help message and exit
--working-dir WORKING_DIR
The working directory for config files and database
Default: current working directory
--config-path CONFIG_PATH
Path to the config YAML file
Default always looks to the current dir: /home/nm/Desktop/tnom/config.yml
--alert-path ALERT_PATH
Path to the alert YAML file
Default always looks to the current dir: /home/nm/Desktop/tnom/alert.yml
--version show program's version number and exit
--prometheus-host PROMETHEUS_HOST
Prometheus host to run on
Overrides host in alert config file
Default: 127.0.0.1 if not specified in config
--prometheus-port PROMETHEUS_PORT
Prometheus port to run on
Overrides port in alert config file
Default: 7130 if not specified in config
Flag --working-dir is optional. It always takes as a default value the
current directory from where the script is run. For example, if you run it while in
/home/user/ that will be considered a working directory. It is recommended to use
for consistency because it will later generate a database in that directory. You can
select any directory but it might make sense to place it inside the project root
directory.
The --config-path is the path to config.yml file. It is optional but as a default,
it takes as a value /working-dir/config.yml. So you can place it inside of your work
dir, or if you want to keep it separate you can create a directory just for the config and then when running use the argument --config-path /path/to/config.yml.
The --alert-path is the path to alert.yml file. It is optional and it functions
identically to the --config-path argument. So you either place it in the working
dir or use argument --alert-path /path/to/alert.yml while running the script.
Run the script using Poetry:
git clone https://github.com/Cogwheel-Validator/tnom.git
cd tnom
poetry install
poetry run python tnom/main.py --working-dir /path/to/working/dir --config-path /path/to/config.yml --alert-path /path/to/alert.yml
Run the script using Python directly:
git clone https://github.com/Cogwheel-Validator/tnom.git
cd tnom
# create and activate a virtual environment
python -m venv v-tnom
source v-tnom/bin/activate
pip install -r requirements.txt
# run the script
python tnom/main.py --working-dir /path/to/working/dir --config-path /path/to/config.yml --alert-path /path/to/alert.yml
Building the binary might take time. The code is compiled to C then it is compiled into an executable binary. Depending on your system, it can up to 30 minutes to build.
For reference, it took about this much to build the binary on these machines: 2 vCPU: ~ 30 minutes 4 vCPU: ~ 15 minutes 8/16t CPU: ~ 5 minutes
It might take more/less time depending on your system. This should just give you some idea of how long it can take.
Build using Poetry:
poetry install
poetry run nuitka_builder.py
Build using Python directly:
python -m venv v-tnom
source v-tnom/bin/activate
pip install -r requirements.txt
python nuitka_builder.py
The binary will be created in the build directory. You can from there run the binary:
./build/tnom --working-dir /path/to/working/dir --config-path /path/to/config.yml --alert-path /path/to/alert.yml
Download the binary:
wget https://github.com/Cogwheel-Validator/tnom/releases/download/v0.3.0/tnom_debian_X86_64
# fix this later when you add the binary
chmod +x tnom
./tnom --working-dir /path/to/working/dir --config-path /path/to/config.yml --alert-path /path/to/alert.yml
The binary can be placed anywhere you want. For example, you can place it in /usr/bin/ or /usr/local/bin/whichever you prefer.
Here you can find some basic setup to deploy it on the server.
This is assuming you run it from the project root directory and you have decided to
also use it as a working dir and store .yml files. It assumes you run the script via
Poetry. If you want to run with Python directly you can just change ExecStart
to (which python) tnom/main.py. If you have working dir placed somewhere else or
plan to place config and alert files somewhere else you can change the paths by
adding arguments. For arguments check this section.
sudo tee /etc/systemd/system/tnom.service > /dev/null <<EOF
[Unit]
Description=” TNOM Script Monitoring Service”
After=network-online.target
[Service]
User=$USER
ExecStart=$(which poetry) run python tnom/main.py
WorkingDirectory=$HOME/tnom
Restart=always
RestartSec=5
KillMode=process
KillSignal=SIGINT
[Install]
WantedBy=multi-user.target
EOF
And this config assumes you run the TNOM via binary. It also assumes you have placed the executable in the /usr/local/bin/ directory.
sudo tee /etc/systemd/system/tnom.service > /dev/null <<EOF
[Unit]
Description=”TNOM binary Monitoring Servi