From c69cb8cc094cc916adbc516b09e944cd3d137c01 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 27 Apr 2024 13:08:07 +0200
Subject: Adding upstream version 1.29.3.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/python.d.plugin/energid/README.md | 77 ++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 collectors/python.d.plugin/energid/README.md

(limited to 'collectors/python.d.plugin/energid/README.md')

diff --git a/collectors/python.d.plugin/energid/README.md b/collectors/python.d.plugin/energid/README.md
new file mode 100644
index 0000000..60c829f
--- /dev/null
+++ b/collectors/python.d.plugin/energid/README.md
@@ -0,0 +1,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
+```
+
+---
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fenergid%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
-- 
cgit v1.2.3