go.d.plugin

go.d.plugin is a Netdata external plugin. It is an orchestrator for data collection modules written in go.

1. It runs as an independent process (ps fax shows it).
2. It is started and stopped automatically by Netdata.
3. It communicates with Netdata via a unidirectional pipe (sending data to the Netdata daemon).
4. Supports any number of data collection modules.
5. Allows each module to have any number of data collection jobs.

Bug reports, feature requests, and questions

Are welcome! We are using netdata/netdata repository for bugs, feature requests, and questions.

• GitHub Issues: report bugs or open a new feature request.
• GitHub Discussions: ask a question or suggest a new idea.

Install

Go.d.plugin is shipped with Netdata.

Required Linux capabilities

All capabilities are set automatically during Netdata installation using the official installation method. No further action required. If you have used a different installation method and need to set the capabilities manually, see the appropriate collector readme.

Capability	Required by
CAP_NET_RAW	Ping
CAP_NET_ADMIN	Wireguard
CAP_DAC_READ_SEARCH	Filecheck

Available modules

Name	Monitors
docker_network	Docker Networking

Configuration

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

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

Configurations are written in YAML.

• plugin configuration
• specific module configuration

Enable a collector

To enable a collector you should edit go.d.conf to uncomment the collector in question and change it from no to yes.

For example, to enable the example plugin you would need to update go.d.conf from something like:

modules:
#  example: no 

to

modules:
  example: yes

Then restart netdata for the change to take effect.

Contributing

If you want to contribute to this project, we are humbled. Please take a look at our contributing guidelines and don't hesitate to contact us in our forums.

How to develop a collector

Read how to write a Netdata collector in Go.

Troubleshooting

Plugin CLI:

Usage:
  orchestrator [OPTIONS] [update every]

Application Options:
  -m, --modules=    module name to run (default: all)
  -c, --config-dir= config dir to read
  -w, --watch-path= config path to watch
  -d, --debug       debug mode
  -v, --version     display the version and exit

Help Options:
  -h, --help        Show this help message

To debug specific module:

# become user netdata
sudo su -s /bin/bash netdata

# run plugin in debug mode
./go.d.plugin -d -m <module name>

Change <module name> to the module name you want to debug. See the whole list of available modules.

Netdata Community

This repository follows the Netdata Code of Conduct and is part of the Netdata Community.

• Community Forums
• Netdata Code of Conduct