Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.78 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.78 KB
Raw

Oasis Monitor

This is a simple typescript application to enable monitoring of a Oasis validator node from Tessellated Geometry.

It checks:

  • If your node is lagging by n blocks versus the Oasis Monitor API
  • If your node is has missed m precommits in a row.

If either condition occurs, it will send you a page via Pager Duty's API.

Setup

  • This software requires the Oasis API server to be running on the machine.
  • Retrieve your pager duty API token, pager duty service identifier, and pager duty email from PagerDuty
  • Modify global variables in src/monitor.ts for the specifics of your setup.

Docker

Build a container:

docker build -t tessellatedgeometry/oasis-monitor

You can then do whatever Docker things you want with the container.

Source

If you're prefer to run from source:

  • Install npm (or yarn if that's your thing).
  • Run npm i to install dependencies.
  • Run ./start.sh.

You'll likely need to do a bit of light customization to make this infrastructure suite your exact needs. PRs to generalize the software or extend functionality are welcome. In particular, it would be cool to provide a customizatble remote API.

Feel free to drop us a line on Keybase or at [email protected] if you need help.

Daemon

A service definition is included. You can modify and deploy the deamon with:

mv oasis-monitor.service /etc/systemd/system/
systemctl enable oasis-monitor
systemctl start oasis-monitor

Say Thanks

If this software is useful to you please consider delegating to us.