diff options
Diffstat (limited to 'collectors/python.d.plugin/energid/README.md')
| -rw-r--r-- | collectors/python.d.plugin/energid/README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/energid/README.md b/collectors/python.d.plugin/energid/README.md new file mode 100644 index 000000000..645170e8f --- /dev/null +++ b/collectors/python.d.plugin/energid/README.md @@ -0,0 +1,62 @@ +# energid + +A collector for [Energi Core](https://github.com/energicryptocurrency/energi) +node instance monitoring. + +As Energi Core Gen 1 & 2 are based on the original Bitcoin code and +supports very similar JSON RPC, there is quite high chance the module works +with many others forks including bitcoind itself. + +Introduces several new charts: + +1. **Blockchain Index** + - blocks + - headers + +2. **Blockchain Difficulty** + - diff + +3. **MemPool** in MiB + - Max + - Usage + - TX Size + +4. **Secure Memory** in KiB + - Total + - Locked + - Used + +5. **Network** + - Connections + +6. **UTXO** (Unspent Transaction Output) + - UTXO + - Xfers (related transactions) + +Configuration is needed in most cases of secure deployment to specify RPC +credentials. However, Energi, Bitcoin and Dash daemons are checked on +startup by default. + +It may be desired to increase retry count for production use due to possibly +long daemon startup. + +## Configuration + +Sample: +```yaml +energi: + host: '127.0.0.1' + port: 9796 + user: energi + pass: energi + +bitcoin: + host: '127.0.0.1' + port: 8332 + user: bitcoin + pass: bitcoin +``` + +--- + +[]() |