Pi-hole is a Linux network-level advertisement and Internet tracker blocking application which
acts as a DNS sinkhole, intended for use on a private network.
This module will monitor one or more
Pi-hole instances using PHP API.
The API exposed data time frame is
for the last 24 hr. All collected values are for that time frame, not for the
module collection interval.
It produces the following set of charts:
- DNS Queries Total (Cached, Blocked and Forwarded) in
- DNS Queries in
- DNS Queries Percentage in
- Unique Clients in
- Domains On Blocklist in
- Blocklist Last Update in
- Unwanted Domains Blocking Status in
If the web password is set and valid following charts will be added:
- DNS Queries Per Type in
- DNS Queries Per Destination in
- Top Clients in
- Top Permitted Domains in
- Top Blocked Domains in
go.d/pihole.conf configuration file using
edit-config from the
Netdata config directory, which is typically at
cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/pihole.conf
Module automatically detects
Pihole web password reading
setupVars.conf file. It expects to find the file in
If you want to monitor remote instance you need to set the password in the module configuration file.
Here is an example for local and remote instances:
- name: local
top_items_entries: 10 # top permitted and top blocked domains charts
- name: remote
- name: remote_https
tls_skip_verify: yes # self signed certificate verification skip
For all available options please see module configuration file.
To troubleshoot issues with the
pihole collector, run the
go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn't working.
First, navigate to your plugins' directory, usually at
/usr/libexec/netdata/plugins.d/. If that's not the case on your
netdata.conf and look for the setting
plugins directory. Once you're in the plugin's directory, switch
sudo -u netdata -s
You can now run the
go.d.plugin to debug the collector:
./go.d.plugin -d -m pihole