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

Shipped with Netdata.

Contributing

If you have time and willing to help, there are a lof of ways to contribute:

Available modules

NameMonitors
activemqActiveMQ
apacheApache
bindISC Bind
cockroachdbCockroachDB
consulConsul
corednsCoreDNS
dnsmasq_dhcpDnsmasq
dns_queryDNS Query RTT
docker_engineDocker Engine
dockerhubDocker Hub
elasticsearchElasticsearch
example-
filecheckFiles and Directories
fluentdFluentd
freeradiusFreeRADIUS
hdfsHDFS
httpcheckAny HTTP Endpoint
k8s_kubeletKubelet
k8s_kubeproxyKube-proxy
lighttpdLighttpd
lighttpd2Lighttpd2
logstashLogstash
mysqlMySQL
nginxNGINX
openvpnOpenVPN
phpdaemonphpDaemon
phpfpmPHP-FPM
piholePi-hole
prometheusAny Prometheus Endpoint
portcheckAny TCP Endpoint
pulsarApache Pulsar
rabbitmqRabbitMQ
scaleioDell EMC ScaleIO
solrSolr
squidlogSquid
springboot2Spring Boot2
tengineTengine
unboundUnbound
vcsavCenter Server Appliance
vernemqVerneMQ
vsphereVMware vCenter Server
web_logApache/NGINX
whoisqueryDomain Expiry
wmiWindows Machines
x509checkDigital Certificates
zookeeperZooKeeper

Configuration

go.d.plugin itself can be configured using the configuration file /etc/netdata/go.d.conf (to edit it on your system run /etc/netdata/edit-config go.d.conf). This file is a BASH script.

Configurations are written in YAML.

Developing

  • Add your module to the modules dir.
  • Import the module in the main.go.
  • To build it execute make from the plugin root dir or hack/go-build.sh.
  • Run it in the debug mode bin/godplugin -d -m <MODULE_NAME>.
  • Use 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.

Last updated on