Pi-hole icon



Plugin: go.d.plugin Module: pihole


This collector monitors Pi-hole instances using PHP API.

The data provided by the API is for the last 24 hours. All collected values refer to this time period and not to the module’s collection interval.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior


This integration doesn’t support auto-detection.


The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.



No action required.



The configuration file name for this integration is go.d/pihole.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/pihole.conf


The following options can be defined globally: update_every, autodetection_retry.

Name Description Default Required
update_every Data collection frequency. 5 False
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 False
url Server URL. True
setup_vars_path Path to setupVars.conf. This file is used to get the web password. /etc/pihole/setupVars.conf False
timeout HTTP request timeout. 5 False
username Username for basic HTTP authentication. False
password Password for basic HTTP authentication. False
proxy_url Proxy URL. False
proxy_username Username for proxy basic HTTP authentication. False
proxy_password Password for proxy basic HTTP authentication. False
method HTTP request method. GET False
body HTTP request body. False
headers HTTP request headers. False
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. False False
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. False False
tls_ca Certification authority that the client uses when verifying the server’s certificates. False
tls_cert Client TLS certificate. False
tls_key Client TLS key. False



A basic example configuration.

  - name: local

HTTPS with self-signed certificate

Remote instance with enabled HTTPS and self-signed certificate.

  - name: local
    tls_skip_verify: yes
    password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b


Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

  - name: local

  - name: remote
    password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b


Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Pi-hole instance

These metrics refer to the entire monitored application.

This scope has no labels.


Metric Dimensions Unit
pihole.dns_queries_total queries queries
pihole.dns_queries cached, blocked, forwarded queries
pihole.dns_queries_percentage cached, blocked, forwarded percentage
pihole.unique_clients unique clients
pihole.domains_on_blocklist blocklist domains
pihole.blocklist_last_update ago seconds
pihole.unwanted_domains_blocking_status enabled, disabled status
pihole.dns_queries_types a, aaaa, any, ptr, soa, srv, txt percentage
pihole.dns_queries_forwarded_destination cached, blocked, other percentage


The following alerts are available:

Alert name On metric Description
pihole_blocklist_last_update pihole.blocklist_last_update gravity.list (blocklist) file last update time
pihole_status pihole.unwanted_domains_blocking_status unwanted domains blocking is disabled


Debug Mode

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.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that’s not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m pihole

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo