go.d.plugin

CircleCI

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.

Install#

Go.d.plugin is shipped with Netdata.

Available modules#

NameMonitors
activemqActiveMQ
apacheApache
bindISC Bind
cockroachdbCockroachDB
consulConsul
corednsCoreDNS
couchbaseCouchbase
couchdbCouchDB
dnsdistDnsdist
dnsmasqDnsmasq DNS Forwarder
dnsmasq_dhcpDnsmasq DHCP
dns_queryDNS Query RTT
docker_engineDocker Engine
dockerhubDocker Hub
elasticsearchElasticsearch
energidEnergi Core
example-
filecheckFiles and Directories
fluentdFluentd
freeradiusFreeRADIUS
hdfsHDFS
httpcheckAny HTTP Endpoint
isc_dhcpdISC dhcpd
k8s_kubeletKubelet
k8s_kubeproxyKube-proxy
lighttpdLighttpd
lighttpd2Lighttpd2
logstashLogstash
mysqlMySQL
nginxNGINX
nginxvtsNGINX VTS
openvpnOpenVPN
phpdaemonphpDaemon
phpfpmPHP-FPM
piholePi-hole
pikaPika
prometheusAny Prometheus Endpoint
portcheckAny TCP Endpoint
powerdnsPowerDNS Authoritative Server
powerdns_recursorPowerDNS Recursor
pulsarApache Pulsar
rabbitmqRabbitMQ
redisRedis
scaleioDell EMC ScaleIO
solrSolr
squidlogSquid
springboot2Spring Boot2
supervisordSupervisor
systemdunitsSystemd unit state
tengineTengine
unboundUnbound
vcsavCenter Server Appliance
vernemqVerneMQ
vsphereVMware vCenter Server
web_logApache/NGINX
whoisqueryDomain Expiry
wmiWindows Machines
x509checkDigital Certificates
zookeeperZooKeeper

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.

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. We have a whole category just for this purpose!

How to develop a collector#

  • 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, cd into the directory (e.g cd go.d.plugin)
  • Add your module to the modules directory.
  • Import the module in the main.go.
  • To build it, run make from the plugin root dir. This will create a new go.d.plugin binary that includes your newly developed collector. It will be placed into the bin directory (e.g go.d.plugin/bin)
  • Run it in the debug mode bin/godplugin -d -m <MODULE_NAME>. This will output the STDOUT of 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.plugin binary 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.plugin binary, but simply rename it to go.d.plugin.old so that the Agent doesn't run it, but you can easily rename it back once you are done.
  • Run make clean when you are done with testing.

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.

Last updated on

Monitor everything in real time – for free

Troubleshoot slowdowns and anomalies in your infrastructure with thousands of per-second metrics, meaningful visualizations, and insightful health alarms with zero configuration.

Get Netdata