blob: c990ae34f0ab159b2019d2906017827117269e9e (
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
|
<!--
title: "IPFS monitoring with Netdata"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ipfs/README.md"
sidebar_label: "IPFS"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Integrations/Monitor/Storage"
-->
# IPFS collector
Collects [`IPFS`](https://ipfs.io) basic information like file system bandwidth, peers and repo metrics.
## Charts
It produces the following charts:
- Bandwidth in `kilobits/s`
- Peers in `peers`
- Repo Size in `GiB`
- Repo Objects in `objects`
## Configuration
Edit the `python.d/ipfs.conf` configuration file using `edit-config` from the Netdata [config
directory](https://github.com/netdata/netdata/blob/master/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/ipfs.conf
```
Calls to the following endpoints are disabled due to `IPFS` bugs:
- `/api/v0/stats/repo` (https://github.com/ipfs/go-ipfs/issues/3874)
- `/api/v0/pin/ls` (https://github.com/ipfs/go-ipfs/issues/7528)
Can be enabled in the collector configuration file.
The configuration needs only `url` to `IPFS` server, here is an example for 2 `IPFS` instances:
```yaml
localhost:
url: 'http://localhost:5001'
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
```
|
