go.d.plugin

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

It runs as an independent process (ps fax shows it).
It is started and stopped automatically by Netdata.
It communicates with Netdata via a unidirectional pipe (sending data to the Netdata daemon).
Supports any number of data collection modules.
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.

Available modules

Name	Monitors
activemq	ActiveMQ
apache	Apache
bind	ISC Bind
cassandra	Cassandra
chrony	Chrony
cockroachdb	CockroachDB
consul	Consul
coredns	CoreDNS
couchbase	Couchbase
couchdb	CouchDB
dnsdist	Dnsdist
dnsmasq	Dnsmasq DNS Forwarder
dnsmasq_dhcp	Dnsmasq DHCP
dns_query	DNS Query RTT
docker	Docker Engine
docker_engine	Docker Engine
dockerhub	Docker Hub
elasticsearch	Elasticsearch
energid	Energi Core
example	-
filecheck	Files and Directories
fluentd	Fluentd
freeradius	FreeRADIUS
haproxy	HAProxy
hdfs	HDFS
httpcheck	Any HTTP Endpoint
isc_dhcpd	ISC DHCP
k8s_kubelet	Kubelet
k8s_kubeproxy	Kube-proxy
k8s_state	Kubernetes cluster state
lighttpd	Lighttpd
lighttpd2	Lighttpd2
logind	systemd-logind
logstash	Logstash
mongoDB	MongoDB
mysql	MySQL
nginx	NGINX
nginxplus	NGINX Plus
nginxvts	NGINX VTS
ntpd	NTP daemon
nvme	NVMe devices
openvpn	OpenVPN
openvpn_status_log	OpenVPN
pgbouncer	PgBouncer
phpdaemon	phpDaemon
phpfpm	PHP-FPM
pihole	Pi-hole
pika	Pika
ping	Any network host
prometheus	Any Prometheus Endpoint
portcheck	Any TCP Endpoint
postgres	PostgreSQL
powerdns	PowerDNS Authoritative Server
powerdns_recursor	PowerDNS Recursor
proxysql	ProxySQL
pulsar	Apache Pulsar
rabbitmq	RabbitMQ
redis	Redis
scaleio	Dell EMC ScaleIO
SNMP	SNMP
solr	Solr
squidlog	Squid
springboot2	Spring Boot2
supervisord	Supervisor
systemdunits	Systemd unit state
tengine	Tengine
traefik	Traefik
unbound	Unbound
vcsa	vCenter Server Appliance
vernemq	VerneMQ
vsphere	VMware vCenter Server
web_log	Apache/NGINX
wireguard	WireGuard
whoisquery	Domain Expiry
wmi	Windows Machines
x509check	Digital Certificates
zookeeper	ZooKeeper

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 modules/init.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.

artemsafiyulin/go.d.plugin