Agent Check: pihole

Overview

This check monitors Pi-hole through the Datadog Agent.

Setup

The Pi-hole check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Pi-hole check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

1. Run the following command to install the Agent integration:

   sudo -u dd-agent -- datadog-agent integration install -t datadog-pihole==<INTEGRATION_VERSION>

2. Configure your integration similar to core integrations.

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 Pi-hole 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.

Log collection

Enable logs collection for Datadog Agent in /etc/datadog-agent/datadog.yaml on Linux platforms. On other platforms, see the Agent Configuration Files guide for the location of your configuration file:

logs_enabled: true

• Enable this configuration block to your pihole.d/conf.yaml file to start collecting Logs:

  logs:
    - type: file
      path: /var/log/pihole.log
      source: pihole

Data Collected

Metrics

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

Events

Pi-hole does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.