go.d.plugin is a
Netdata external plugin. It is an orchestrator for data collection modules written in
- It runs as an independent process
ps faxshows it.
- It is started and stopped automatically by
- It communicates with
Netdatavia a unidirectional pipe (sending data to the
- Supports any number of data collection modules.
- Allows each module to have any number of data collection jobs.
Go.d.plugin is shipped with
go.d.conf configuration file using
edit-config from the Netdata config
directory, which is typically at
Configurations are written in YAML.
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. We have a whole category just for this purpose!
- Take a look at our contributing guidelines.
- Read the How to develop a collector in Go guide.
- Fork this repository to your personal GitHub account.
- Clone locally the forked repository (e.g
git clone https://github.com/odyslam/go.d.plugin).
- Using a terminal,
cdinto the directory (e.g
- Add your module to the modules directory.
- Import the module in the main.go.
- To build it, run
makefrom the plugin root dir. This will create a new
go.d.pluginbinary that includes your newly developed collector. It will be placed into the
- Run it in the debug mode
bin/godplugin -d -m <MODULE_NAME>. This will output the
STDOUTof the collector, the same output that is sent to the Netdata Agent and is transformed into charts. You can read more about this collector API in our documentation.
- If you want to test the collector with the actual Netdata Agent, you need to replace the
go.d.pluginbinary that exists in the Netdata Agent installation directory with the one you just compiled. Once you restart the Netdata Agent, it will detect and run it, creating all the charts. It is advised not to remove the default
go.d.pluginbinary, but simply rename it to
go.d.plugin.oldso that the Agent doesn't run it, but you can easily rename it back once you are done.
make cleanwhen you are done with testing.
To debug specific module:
<module name> to the module name you want to debug.
See the whole list of available modules.
This repository follows the Netdata Code of Conduct and is part of the Netdata Community.