example

Example module

An example data collection module. Use it as an example writing a new module.

Charts

This module produces example charts with random values. Number of charts, dimensions and chart type is configurable.

Configuration

Disabled by default. Should be explicitly enabled in go.d.conf.

# go.d.conf
modules:
  example: yes

Edit the go.d/example.conf configuration file using edit-config from the Agent's config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/example.conf

Here is an example configuration with several jobs:

jobs:
  - name: example
    charts:
      num: 3
      dimensions: 5

  - name: hidden_example
    hidden_charts:
      num: 3
      dimensions: 5

For all available options, see the Example collector's configuration file.

Troubleshooting

To troubleshoot issues with the Example collector, run the go.d.plugin orchestrator with the debug option enabled. The output should give you clues as to why the collector isn't working.

First, navigate to your plugins directory, usually at /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 plugins directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin orchestrator to debug the collector:

./go.d.plugin -d -m example