Plugin: python.d.plugin Module: example
Example collector that generates some random numbers as metrics.
If you want to write your own collector, read our writing a new Python module tutorial.
get_data() function uses
random.randint() to generate a random number which will be collected as a metric.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
This integration doesn’t support auto-detection.
The default configuration for this integration does not impose any limits on data collection.
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/example.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.
|The number of lines to create.
|The lower bound of numbers to randomly sample from.
|The upper bound of numbers to randomly sample from.
|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.
|Job name. This value will overwrite the
job_name value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
A basic example configuration.
name: "Four Lines"
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.
There are no alerts configured by default for this integration.
To troubleshoot issues with the
example 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 example debug trace