summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/ipfs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/ipfs/README.md')
-rw-r--r--collectors/python.d.plugin/ipfs/README.md28
1 files changed, 24 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/ipfs/README.md b/collectors/python.d.plugin/ipfs/README.md
index 8f5e53b1..c990ae34 100644
--- a/collectors/python.d.plugin/ipfs/README.md
+++ b/collectors/python.d.plugin/ipfs/README.md
@@ -4,10 +4,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/pyth
sidebar_label: "IPFS"
learn_status: "Published"
learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/Storage"
+learn_rel_path: "Integrations/Monitor/Storage"
-->
-# IPFS monitoring with Netdata
+# IPFS collector
Collects [`IPFS`](https://ipfs.io) basic information like file system bandwidth, peers and repo metrics.
@@ -30,7 +30,7 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
sudo ./edit-config python.d/ipfs.conf
```
----
+
Calls to the following endpoints are disabled due to `IPFS` bugs:
@@ -49,6 +49,26 @@ remote:
url: 'http://203.0.113.10::5001'
```
----
+
+### Troubleshooting
+
+To troubleshoot issues with the `ipfs` module, run the `python.d.plugin` with the debug option enabled. The
+output will give you the output of the data collection job or error messages on why the collector isn't working.
+
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
+plugin's directory, switch to the `netdata` user.
+
+```bash
+cd /usr/libexec/netdata/plugins.d/
+sudo su -s /bin/bash netdata
+```
+
+Now you can manually run the `ipfs` module in debug mode:
+
+```bash
+./python.d.plugin ipfs debug trace
+```
+