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 theNetdata
daemon). - Supports any number of data collection modules.
- Allows each module to have any number of data collection jobs.
#
InstallGo.d.plugin is shipped with Netdata
.
#
Available modulesName | Monitors |
---|---|
activemq | ActiveMQ |
apache | Apache |
bind | ISC Bind |
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_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 dhcpd |
k8s_kubelet | Kubelet |
k8s_kubeproxy | Kube-proxy |
lighttpd | Lighttpd |
lighttpd2 | Lighttpd2 |
logstash | Logstash |
mongoDB | MongoDB |
mysql | MySQL |
nginx | NGINX |
nginxvts | NGINX VTS |
openvpn | OpenVPN |
phpdaemon | phpDaemon |
phpfpm | PHP-FPM |
pihole | Pi-hole |
pika | Pika |
prometheus | Any Prometheus Endpoint |
portcheck | Any TCP Endpoint |
powerdns | PowerDNS Authoritative Server |
powerdns_recursor | PowerDNS Recursor |
pulsar | Apache Pulsar |
rabbitmq | RabbitMQ |
redis | Redis |
scaleio | Dell EMC ScaleIO |
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 |
whoisquery | Domain Expiry |
wmi | Windows Machines |
x509check | Digital Certificates |
zookeeper | ZooKeeper |
#
ConfigurationEdit the go.d.conf
configuration file using edit-config
from the
Netdata config directory, which is typically at /etc/netdata
.
Configurations are written in YAML.
#
ContributingIf 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.gcd go.d.plugin
) - Add your module to the modules directory.
- Import the module in the init.go.
- To build it, run
make
from the plugin root dir. This will create a newgo.d.plugin
binary that includes your newly developed collector. It will be placed into thebin
directory (e.ggo.d.plugin/bin
) - Run it in the debug mode
bin/godplugin -d -m <MODULE_NAME>
. This will output theSTDOUT
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 defaultgo.d.plugin
binary, but simply rename it togo.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.
#
TroubleshootingPlugin CLI:
To debug specific module:
Change <module name>
to the module name you want to debug. See the whole list of available
modules.
#
Netdata CommunityThis repository follows the Netdata Code of Conduct and is part of the Netdata Community.