summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/energid/README.md
blob: 73e39ae148cffb3ba1c30a5aa70dfc3dabe22ed8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!--
title: "Energi Core node monitoring with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/energid/README.md
sidebar_label: "Energi Core"
-->

# Energi Core node monitoring with Netdata

Monitors blockchain, memory, network and unspent transactions statistics.


As [Energi Core](https://github.com/energicryptocurrency/energi) 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

Edit the `python.d/energid.conf` configuration file using `edit-config` from the Netdata [config
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.

```bash
cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/energid.conf
```

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

---