Skip to content
Branch: master
Find file History
jchristgit and ilyam8 Add a riak plugin (#6286)
* Add a Riak plugin.
Latest commit c5ab825 Jun 18, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
apps.plugin Add perforce server process monitoring (#6064) Jun 3, 2019
cgroups.plugin Increase the cpu_limit chart precision (#6172) Jun 4, 2019
charts.d.plugin Pass correct info to run funct. (#6126) May 28, 2019
checks.plugin Ga (#4938) Dec 7, 2018
cups.plugin cups.plugin: Support older versions (#5350) Feb 11, 2019
diskspace.plugin Allow user to override the default behavior for read-only mounts (#5327) Feb 5, 2019
fping.plugin Update fping version (#5719) Mar 27, 2019
freebsd.plugin Fix FreeBSD plugin Codacy issues (#5338) Feb 6, 2019
freeipmi.plugin Have the debug option set the freeipmi debug flags (#5548) Mar 4, 2019
idlejitter.plugin Ga (#4938) Dec 7, 2018
ioping.plugin Add ioping plugin (#5725) Apr 23, 2019
macos.plugin Make units compliant with IEC standard (#4985) Dec 17, 2018
nfacct.plugin Fix typo in nfacct.plugin (#6260) Jun 13, 2019
node.d.plugin Remove codacy warnings from sma_webbox (#5330) Feb 5, 2019
plugins.d Add ioping plugin (#5725) Apr 23, 2019
proc.plugin Fix mdstat disks chart (#6164) Jun 4, 2019
python.d.plugin Add a riak plugin (#6286) Jun 18, 2019
statsd.plugin remove cross-directory dependency in build system (#5012) Dec 18, 2018
tc.plugin Minor fixes around plugin_directories initialization (#5536) Mar 5, 2019
xenstat.plugin Add xenstat plugin (#5660) Mar 27, 2019
Makefile.am Add ioping plugin (#5725) Apr 23, 2019
README.md Add ioping plugin (#5725) Apr 23, 2019
all.h Add IPC shared memory charts (#5522) Mar 6, 2019

README.md

Data collection plugins

netdata supports internal and external data collection plugins:

  • internal plugins are written in C and run as threads inside the netdata daemon.

  • external plugins may be written in any computer language and are spawn as independent long-running processes by the netdata daemon. They communicate with the netdata daemon via pipes (stdout communication).

To minimize the number of processes spawn for data collection, netdata also supports plugin orchestrators.

  • plugin orchestrators are external plugins that do not collect any data by themeselves. Instead they support data collection modules written in the language of the orchestrator. Usually the orchestrator provides a higher level abstraction, making it ideal for writing new data collection modules with the minimum of code.

    Currently netdata provides plugin orchestrators BASH v4+ charts.d.plugin, node.js node.d.plugin and python v2+ (including v3) python.d.plugin.

Netdata Plugins

plugin lang O/S runs as modular description
apps.plugin C linux, freebsd external - monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by process, user and user group.
cgroups.plugin C linux internal - collects resource usage of Containers, libvirt VMs and systemd services, on Linux systems
charts.d.plugin BASH v4+ any external yes a plugin orchestrator for data collection modules written in BASH v4+.
checks.plugin C any internal - a debugging plugin (by default it is disabled)
cups.plugin C any external - monitors CUPS
diskspace.plugin C linux internal - collects disk space usage metrics on Linux mount points
fping.plugin C any external - measures network latency, jitter and packet loss between the monitored node and any number of remote network end points.
ioping.plugin C any external - measures disk read/write latency.
freebsd.plugin C freebsd internal yes collects resource usage and performance data on FreeBSD systems
freeipmi.plugin C linux, freebsd external - collects metrics from enterprise hardware sensors, on Linux and FreeBSD servers.
idlejitter.plugin C any internal - measures CPU latency and jitter on all operating systems
macos.plugin C macos internal yes collects resource usage and performance data on MacOS systems
nfacct.plugin C linux external - collects netfilter firewall, connection tracker and accounting metrics using libmnl and libnetfilter_acct
xenstat.plugin C linux external - collects XenServer and XCP-ng metrics using libxenstat
node.d.plugin node.js any external yes a plugin orchestrator for data collection modules written in node.js.
plugins.d C any internal - implements the external plugins API and serves external plugins
proc.plugin C linux internal yes collects resource usage and performance data on Linux systems
python.d.plugin python v2+ any external yes a plugin orchestrator for data collection modules written in python v2 or v3 (both are supported).
statsd.plugin C any internal - implements a high performance statsd server for netdata
tc.plugin C linux internal - collects traffic QoS metrics (tc) of Linux network interfaces

Enabling and Disabling plugins

Each plugin can be enabled or disabled via netdata.conf, section [plugins].

At this section there a list of all the plugins with a boolean setting to enable them or disable them.

The exception is statsd.plugin that has its own [statsd] section.

Once a plugin is enabled, consult the page of each plugin for additional configuration options.

All external plugins are managed by plugins.d, which provides additional management options.

Internal Plugins

Each of the internal plugins runs as a thread inside the netdata daemon. Once this thread has started, the plugin may spawn additional threads according to its design.

Internal Plugins API

The internal data collection API consists of the following calls:

collect_data() {
    // collect data here (one iteration)

    collected_number collected_value = collect_a_value();

    // give the metrics to netdata

    static RRDSET *st = NULL; // the chart
    static RRDDIM *rd = NULL; // a dimension attached to this chart

    if(unlikely(!st)) {
        // we haven't created this chart before
        // create it now
        st = rrdset_create_localhost(
                "type"
                , "id"
                , "name"
                , "family"
                , "context"
                , "Chart Title"
                , "units"
                , "plugin-name"
                , "module-name"
                , priority
                , update_every
                , chart_type
        );

        // attach a metric to it
        rd = rrddim_add(st, "id", "name", multiplier, divider, algorithm);
    }
    else {
        // this chart is already created
        // let netdata know we start a new iteration on it
        rrdset_next(st);
    }

    // give the collected value(s) to the chart
    rrddim_set_by_pointer(st, rd, collected_value);

    // signal netdata we are done with this iteration
    rrdset_done(st);
}

Of course netdata has a lot of libraries to help you also in collecting the metrics. The best way to find your way through this, is to examine what other similar plugins do.

External Plugins

External plugins use the API and are managed by plugins.d.

analytics

You can’t perform that action at this time.