IPFS
IPFS
Plugin: go.d.plugin Module: ipfs
Overview
This collector monitors IPFS daemon health and network activity.
It uses RPC API to collect metrics.
Used endpoints:
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
By default, it detects IPFS instances running on localhost that are listening on port 5001.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
Calls to the following endpoints are disabled by default due to IPFS bugs:
Disabled by default due to potential high CPU usage. Consider enabling only if necessary.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/ipfs.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/ipfs.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| repoapi | Enables querying the /api/v0/stats/repo endpoint for repository statistics. | no | no |
| pinapi | Enables querying the /api/v0/pin/ls endpoint to retrieve a list of all pinned objects. | no | no |
| url | Server URL. | http://127.0.0.1:5001 | yes |
| timeout | HTTP request timeout. | 1 | no |
| username | Username for basic HTTP authentication. | no | |
| password | Password for basic HTTP authentication. | no | |
| proxy_url | Proxy URL. | no | |
| proxy_username | Username for proxy basic HTTP authentication. | no | |
| proxy_password | Password for proxy basic HTTP authentication. | no | |
| method | HTTP request method. | POST | no |
| body | HTTP request body. | no | |
| headers | HTTP request headers. | no | |
| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
| tls_ca | Certification authority that the client uses when verifying the server’s certificates. | no | |
| tls_cert | Client TLS certificate. | no | |
| tls_key | Client TLS key. | no |
Examples
Basic
A basic example configuration.
jobs:
- name: local
url: http://127.0.0.1:5001
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
url: http://127.0.0.1:5001
- name: remote
url: http://192.0.2.1:5001
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per IPFS instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| ipfs.bandwidth | in, out | bytes/s |
| ipfs.peers | peers | peers |
| ipfs.datastore_space_utilization | used | percent |
| ipfs.repo_size | size | bytes |
| ipfs.repo_objects | objects | objects |
| ipfs.repo_pinned_objects | pinned, recursive_pins | objects |
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| ipfs_datastore_usage | ipfs.datastore_space_utilization | IPFS datastore utilization |
Troubleshooting
Debug Mode
To troubleshoot issues with the ipfs collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m ipfs
Getting Logs
If you’re encountering problems with the ipfs collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep ipfs
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:
grep ipfs /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep ipfs