Agent Check: pihole

Official release

Official release can be found on integrations-extras: https://github.com/DataDog/integrations-extras/tree/master/pihole

Overview

This check monitors pihole through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

To install the pihole check on your host:

1. Install the developer toolkit on any machine.
2. Run ddev release build pihole to build the package.
3. Download the Datadog Agent.
4. Upload the build artifact to any host with an Agent andrun datadog-agent integration install -w path/to/pihole/dist/<ARTIFACT_NAME>.whl.

Configuration

1. Edit the pihole.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your pihole performance data. See the sample pihole.d/conf.yaml for all available configuration options.

2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for pihole under the Checks section.

Available metrics

• Queries forwarded
• Domains being blocked
• Ads percentage today
• Ads blocked today
• DNS queries today
• Total clients
• Unique clients
• Queries cached
• Unique Domains
• Top Queries
• Top Ads
• Top clients
• Forward destinations
• Query type
• Reply type
• DNS queries by host

Metrics

See metadata.csv for a list of metrics provided by this check.

Service Checks

pi-hole.can.connect

Events

pihole does not include any events.

Troubleshooting

Need help? Contact Datadog support.