Health Check

Orbs network node heart beat

Overview

Health-check is a set of checks performed against various vchains. Each check sends a transaction at a given period of time.
Metrics are read from nodes. If the node is healthy, we should see the transactions in graphana dashboard.

Adding health check

1. Add check file

Folder /src contains files with checks. Create a new file with relevant call.
Important! It's your responsibility to invoke the function periodically. You can do it either by setInterval or using any other library for cron jobs.

2. Invoke your check

Edit index.js file to add another fork process. Your check will run as a separate process independently from others, meaning, if other checks throw exception, your process will keep running.

Deployment

1. Open a terminal
2. ssh -o StrictHostKeyChecking=no [email protected] [assuming you have a valid certificate to enter]
3. cd /opt/health-check/
4. git pull
5. Kill previous process screen -S healthcheck -X quit
6. Start a new detached process screen -dmS healthcheck npm start

Licence

MIT.