pihole

This module will monitor one or more Pihole instances using PHP API.

The API exposed data time frame is for the last 24 hr. So all the collected values are for that time time frame, not for the module collection interval.

It produces the following set of charts:

  1. DNS Queries Total (Cached, Blocked and Forwarded) in queries * queries

  2. DNS Queries in queries * cached * blocked * forwarded

  3. DNS Queries Percentage in percentage * cached * blocked * forwarded

  4. Unique Clients in clients * cached * blocked * forwarded

  5. Domains On Blocklist in domains * blocklist

  6. Blocklist Last Update in seconds * ago

  7. Unwanted Domains Blocking Status in boolean * enabled

If the web password is set and valid following charts will be added:

  1. DNS Queries Per Type in percentage * A * AAAA * ANY * PTR * SOA * SRV * TXT

  2. DNS Queries Per Destination in percentage * per destination (cache, blocklist, etc.)

  3. Top Clients in requests * per client

  4. Top Permitted Domains in hits * per domain

  5. Top Blocked Domains in hits * per domain

configuration

Module automatically detects Pihole web password reading setupVars.conf file.

It expects to find the file in the /etc/pihole/ directory.

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:

jobs:
  - name                 : local
    top_clients_entries  : 10
    top_items_entries    : 10  # top permitted and top blocked domains charts

  - name                 : remote
    url                  : http://10.0.0.1
    password             : 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b

  - name                 : remote_https
    url                  : https://10.0.0.2
    password             : 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b
    tls_skip_verify      : yes  # self signed certificate verification skip

For all available options please see module configuration file.