dnsmasq_exporter/README.md
Brandon Richardson e3caa1dcf7
feat: add option to enable granular lease metrics (#24)
Introduce a new flag that can be used to expose each DHCP lease as a
specific metric. Given the high cardinality of these metrics, exposition
of lease information is disabled by default.

This feature takes cues from node_exporter collectors which are
disabled by default, like the `processes` or `systemd` collectors for
instance. Typically, high-cardinality metrics are against prometheus
best-practices but for smaller networks (like home networks) these
features can be quite powerful.
2023-04-07 18:09:17 +02:00

49 lines
1.2 KiB
Markdown

# dnsmasq exporter
[![Build Status](https://github.com/google/dnsmasq_exporter/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/google/dnsmasq_exporter/actions)
dnsmasq_exporter is an exporter for [Prometheus](https://prometheus.io/),
allowing you to monitor/alert on the number of DHCP leases and various DNS
statistics.
The minimum required version of dnsmasq is 2.69, which added support for
querying the statistics via DNS.
See also the “cache statistics” section in
https://manpages.debian.org/stretch/dnsmasq-base/dnsmasq.8.en.html#NOTES
This is not an official Google product.
## Installation
``` shell
go get -u github.com/google/dnsmasq_exporter
```
## Usage
Place `dnsmasq_exporter.service` in
`/etc/systemd/system/dnsmasq_exporter.service`, then enable and start the
service using:
```shell
systemctl daemon-reload
systemctl enable --now dnsmasq_exporter
```
### Alternative usage
```shell
docker build -t dnsmasq_exporter .
docker run --restart=unless-stopped --net=host dnsmasq_exporter
```
Then, add the endpoint to your Prometheus configuration file:
```yaml
scrape_configs:
- job_name: dnsmasq
static_configs:
- targets: ['localhost:9153']
```