119 lines
6.5 KiB
Markdown
119 lines
6.5 KiB
Markdown
# PI-Hole Prometheus Exporter
|
|
|
|
[](https://travis-ci.org/eko/pihole-exporte)
|
|
[](https://godoc.org/github.com/eko/pihole-exporter)
|
|
[](https://goreportcard.com/report/github.com/eko/pihole-exporter)
|
|
|
|
This is a Prometheus exporter for [PI-Hole](https://pi-hole.net/)'s Raspberry PI ad blocker.
|
|
|
|
## Prerequisites
|
|
|
|
* [Go](https://golang.org/doc/)
|
|
|
|
## Installation
|
|
|
|
### Download binary
|
|
|
|
You can also download the latest version of the binary built for your architecture here:
|
|
|
|
* Architecture **i386** [
|
|
[Darwin](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-darwin-386) /
|
|
[Linux](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-linux-386) /
|
|
[Windows](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-windows-386.exe)
|
|
]
|
|
* Architecture **amd64** [
|
|
[Darwin](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-darwin-amd64) /
|
|
[Linux](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-linux-amd64) /
|
|
[Windows](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-windows-amd64.exe)
|
|
]
|
|
* Architecture **arm** [
|
|
[Linux](https://github.com/eko/pihole-exporter/releases/latest/download/pihole_exporter-linux-arm)
|
|
]
|
|
|
|
### From sources
|
|
|
|
First, you have to retrieve the project sources by using one of the following way:
|
|
```bash
|
|
$ go get -u github.com/eko/pihole-exporter
|
|
# or
|
|
$ git clone https://github.com/eko/pihole-exporter.git
|
|
```
|
|
|
|
Then, build the binary (here, an example to run on Raspberry PI ARM architecture):
|
|
```bash
|
|
$ GOOS=linux GOARCH=arm GOARM=7 go build -o pihole_exporter .
|
|
```
|
|
|
|
## Usage
|
|
|
|
In order to run the exporter, type the following command (arguments are optional):
|
|
|
|
```bash
|
|
$ ./pihole_exporter -pihole_hostname 192.168.1.10 -pihole_password azerty
|
|
|
|
2019/05/09 20:19:52 ------------------------------------
|
|
2019/05/09 20:19:52 - PI-Hole exporter configuration -
|
|
2019/05/09 20:19:52 ------------------------------------
|
|
2019/05/09 20:19:52 PIHoleHostname : 192.168.1.10
|
|
2019/05/09 20:19:52 PIHolePassword : azerty
|
|
2019/05/09 20:19:52 Port : 9311
|
|
2019/05/09 20:19:52 Interval : 10s
|
|
2019/05/09 20:19:52 ------------------------------------
|
|
2019/05/09 20:19:52 New Prometheus metric registered: domains_blocked
|
|
2019/05/09 20:19:52 New Prometheus metric registered: dns_queries_today
|
|
2019/05/09 20:19:52 New Prometheus metric registered: ads_blocked_today
|
|
2019/05/09 20:19:52 New Prometheus metric registered: ads_percentag_today
|
|
2019/05/09 20:19:52 New Prometheus metric registered: unique_domains
|
|
2019/05/09 20:19:52 New Prometheus metric registered: queries_forwarded
|
|
2019/05/09 20:19:52 New Prometheus metric registered: queries_cached
|
|
2019/05/09 20:19:52 New Prometheus metric registered: clients_ever_seen
|
|
2019/05/09 20:19:52 New Prometheus metric registered: unique_clients
|
|
2019/05/09 20:19:52 New Prometheus metric registered: dns_queries_all_types
|
|
2019/05/09 20:19:52 New Prometheus metric registered: reply
|
|
2019/05/09 20:19:52 New Prometheus metric registered: top_queries
|
|
2019/05/09 20:19:52 New Prometheus metric registered: top_ads
|
|
2019/05/09 20:19:52 New Prometheus metric registered: top_sources
|
|
2019/05/09 20:19:52 New Prometheus metric registered: forward_destinations
|
|
2019/05/09 20:19:52 New Prometheus metric registered: querytypes
|
|
2019/05/09 20:19:52 New Prometheus metric registered: status
|
|
2019/05/09 20:19:52 Starting HTTP server
|
|
2019/05/09 20:19:54 New tick of statistics: 648 ads blocked / 66796 total DNS querie
|
|
...
|
|
```
|
|
|
|
## Available CLI options
|
|
```bash
|
|
# Interval of time the exporter will fetch data from PI-Hole
|
|
-interval duration (optional) (default 10s)
|
|
|
|
# Hostname of the Raspberry PI where PI-Hole is installed
|
|
-pihole_hostname string (optional) (default "127.0.0.1")
|
|
|
|
# Password defined on the PI-Hole interface
|
|
-pihole_password string (optional)
|
|
|
|
# Port to be used for the exporter
|
|
-port string (optional) (default "9311")
|
|
```
|
|
|
|
## Available Prometheus metrics
|
|
|
|
| Metric name | Description |
|
|
|:----------------------------:|-------------------------------------------------------------------------------------------|
|
|
| pihole_domains_being_blocked | This represent the number of domains being blocked |
|
|
| pihole_dns_queries_today | This represent the number of DNS queries made over the current day |
|
|
| pihole_ads_blocked_today | This represent the number of ads blocked over the current day |
|
|
| pihole_ads_percentage_today | This represent the percentage of ads blocked over the current day |
|
|
| pihole_unique_domains | This represent the number of unique domains seen |
|
|
| pihole_queries_forwarded | This represent the number of queries forwarded |
|
|
| pihole_queries_cached | This represent the number of queries cached |
|
|
| pihole_clients_ever_seen | This represent the number of clients ever seen |
|
|
| pihole_unique_clients | This represent the number of unique clients seen |
|
|
| pihole_dns_queries_all_types | This represent the number of DNS queries made for all types |
|
|
| pihole_reply | This represent the number of replies made for all types |
|
|
| pihole_top_queries | This represent the number of top queries made by PI-Hole by domain |
|
|
| pihole_top_ads | This represent the number of top ads made by PI-Hole by domain |
|
|
| pihole_top_sources | This represent the number of top sources requests made by PI-Hole by source host |
|
|
| pihole_forward_destinations | This represent the number of forward destinations requests made by PI-Hole by destination |
|
|
| pihole_querytypes | This represent the number of queries made by PI-Hole by type |
|
|
| pihole_status | This represent if PI-Hole is enabled |
|