Project: Netdata (Observability and Analysis / Observability)
File: pi-hole.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pihole/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pihole/metadata.yaml" sidebar_label: "Pi-hole" learn_status: "Published" learnrelpath: "Collecting Metrics/DNS and DHCP Servers" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/pihole.png" width="150"/> Plugin: go.d.plugin Module: pihole <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors Pi-hole instances using . 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. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | pihole.dnsqueriestotal | queries | queries | | pihole.dns_queries | cached, blocked, forwarded | queries | | pihole.dnsqueriespercentage | cached, blocked, forwarded | percentage | | pihole.unique_clients | unique | clients | | pihole.domainsonblocklist | blocklist | domains | | pihole.blocklistlastupdate | ago | seconds | | pihole.unwanteddomainsblocking_status | enabled, disabled | status | | pihole.dnsqueriestypes | a, aaaa, any, ptr, soa, srv, txt | percentage | | pihole.dnsqueriesforwarded_destination | cached, blocked, other | percentage | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | pihole.blocklistlastupdate | gravity.list (blocklist) file last update time | | | pihole.unwanteddomainsblocking_status | unwanted domains blocking is disabled | 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 . ```bash 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: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in

Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1 | yes | | setupvarspath | Path to setupVars.conf. This file is used to get the web password. | /etc/pihole/setupVars.conf | no | | timeout | HTTP request timeout. | 5 | no | | username | Username for basic HTTP authentication. | | no | | password | Password for basic HTTP authentication. | | no | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no | </details> A basic example configuration. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1 ``` </details> Remote instance with enabled HTTPS and self-signed certificate. <details><summary>Config</summary> ```yaml jobs: name: local url: https://203.0.113.11 tlsskipverify: yes password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1 name: remote url: http://203.0.113.10 password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m pihole ```