Plugin: python.d.plugin Module: ipfs
This collector monitors IPFS server metrics about its quality and performance.
It connects to an http endpoint of the IPFS server to collect the metrics
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
If the endpoint is accessible by the Agent, netdata will autodetect it
Calls to the following endpoints are disabled due to IPFS bugs:
The default configuration for this integration is not expected to impose a significant performance impact on the system.
No action required.
The configuration file name for this integration is
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 python.d/ipfs.conf
There are 2 sections:
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a
job_name value which will appear in the dashboard, unless a
name parameter is specified.
|Sets the default data collection frequency.
|Controls the order of charts at the netdata dashboard.
|Sets the job re-check interval in seconds.
|Indicates whether to apply penalty to update_every in case of failures.
|The JOB’s name as it will appear at the dashboard (by default is the job_name)
|URL to the IPFS API
|Collect repo metrics.
|Set status of IPFS pinned object polling.
A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default.
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the entire monitored application.
This scope has no labels.
|objects, pinned, recursive_pins
The following alerts are available:
|IPFS datastore utilization
To troubleshoot issues with the
ipfs collector, run the
python.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.d directory, usually at
/usr/libexec/netdata/plugins.d/. If that’s not the case on
your system, open
netdata.conf and look for the
plugins setting under
Switch to the
sudo -u netdata -s
python.d.plugin to debug the collector:
./python.d.plugin ipfs debug trace