https://github.com/orbs-network/health-check

Contract + cron jobs that sends transaction every min
https://github.com/orbs-network/health-check

health-check heartbeat monitoring stability

Last synced: about 1 month ago
JSON representation

Contract + cron jobs that sends transaction every min

• Host: GitHub
• URL: https://github.com/orbs-network/health-check
• Owner: orbs-network
• License: mit
• Created: 2019-07-31T08:17:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-09T13:31:44.000Z (almost 4 years ago)
• Last Synced: 2023-03-01T22:32:50.699Z (almost 2 years ago)
• Topics: health-check, heartbeat, monitoring, stability
• Language: JavaScript
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://orbsnetwork.grafana.net/d/a-3pW-3mk/orbs-production).

## 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

1. `ssh -o StrictHostKeyChecking=no [email protected]` [assuming you have a valid certificate to enter]

1. `cd /opt/health-check/`

1. `git pull`

1. Kill previous process `screen -S healthcheck -X quit`

1. Start a new detached process `screen -dmS healthcheck npm start`

## Licence

MIT.