This script is designed for collecting server & DeFiChain node information of your system and send them to the DeFiChain Masternode Health API.
For a closed look in it's functionality there's a detailled documentation.
- Install pip3 (pip from python v3. Some operating systems just name it
pip) - Run
pip3 install masternode-health
Make sure you set rpcuser=xxx and rpcpassword=xxx in your defi.conf
You can choose the username and password by yourself.
Hint: restart your node after updating your defi.conf
pip3 install --upgrade masternode-health
This scripts needs a DeFiChain Masternode Health API key. Take a look at the documentation.
Open up a new tab in your browser, paste in that URL
https://api.defichain-masternode-health.com/setup/api_key
You'll get something like this:
{"message":"API key generated","api_key":"537e13a8-d027-45db-8f51-92b5219b203f"}
The part after "api_key":" (537e13a8-d027-45db-8f51-92b5219b203f) is your API key. Copy it (without "}), store it in a safe place like your password manager and close that browser tab because you don't need it anymore.
You can either run masternode-health by calling it with it's relative path in your user's directory:
~/.local/bin/masternode-health --help
OR you can create a symlink for making the masternode-health command accessible from anywhere on your system. The following command requires sudo rights.
sudo ln -sf ~/.local/bin/masternode-health /usr/local/bin/masternode-health
To keep it simple, the following examples do not contain the relative path like described above.
$ masternode-health --help
usage: masternode-health [-h] [--max-block-seconds MAX_BLOCK_SECONDS] [--rpchost RPCHOST] [--verbose] [--report] [--defi-path DEFI_PATH] [--defi-conf DEFI_CONF] [--api-key API_KEY] [--version]
DefiChain Masternode Monitor
optional arguments:
-h, --help show this help message and exit
--max-block-seconds MAX_BLOCK_SECONDS
Alert if node did not try to calculate hash within max-block-seconds (default: 30 seconds)
--rpchost RPCHOST RPC host (default: http://localhost:8554)
--verbose Prints stats to stdout
--report Force sending report when using in combination with --verbose
--defi-path DEFI_PATH
Path to your .defi folder. Default: ~/.defi
--defi-conf DEFI_CONF
Path to your defi.conf. Default: ~/.defi/defi.conf
--api-key API_KEY API Key
--version Returns masternode-health version
You can manually run it with
$ masternode-health --verbose --report --api-key=your-api-key
----- [ server stats ] -----
System Load [ ] 1%
Memory Usage: [ ] 3%
Disk Usage: [ ] 6%
Log Size: 16 MB
----- [ node info ] -----
Node Version: v1.8.1.0-release
Uptime: 9 days, 2:50:25
Local Block Height: 1149879
Local Block Hash: 526fe2a061a9a7bde7b07d308b986624c1dd49aee0ac58b2ad982dd300416ef6
Connection Count: 8
Operator ..xzy: ✅
Operator ..abc: ✅
Please don't forget to replace the following parts with your own:
- your-api-key: make an educated guess ;)
Add calling Masternode Health into your crontab to check every 10 minutes.
First, open up a text editor to edit your crontab with:
crontab -e
Add the following line to run it every 10 minutes: (Masternode Health won't accept any higher frequency than every 10 minutes)
*/10 * * * * ~/.local/bin/masternode-health --api-key=your-api-key
Warning: The API allows only 1 call to each endpoint every 300 seconds. Don't let the cron run more often than every 5 minutes!
Please don't forget to replace the following parts with your own:
- your-api-key: make an educated guess ;)
To take a look at the collected data, you can use the --verbose argument.
With this argument, no data is sent to the API. To force sending the data and viewing the verbose output use the --report argument in parallel.
Open issue or submit a pull request to https://github.com/defichain-api/masternode-health-server
@sandrich implemented this tool alone. Want to give him a small thank you? His coffee cash box (in DFI) is: df1qvzdgd85m67eym95l0jxrdn6aue5cjthpg78r4z
MIT