2021-09-08 22:03:06 +02:00
# Integration in Grafana
2021-03-05 08:02:00 +01:00
2021-09-08 22:03:06 +02:00
## Prometheus
### Prometheus export
2021-03-05 08:02:00 +01:00
Blocky can optionally export metrics for [Prometheus ](https://prometheus.io/ ).
Following metrics will be exported:
| name | Description |
| ------------------------------------------------ | -------------------------------------------------------- |
| blocky_blacklist_cache / blocky_whitelist_cache | Number of entries in blacklist/whitelist cache, partitioned by group |
| blocky_error_total | Counter for internal errors |
| blocky_query_total | Number of total queries, partitioned by client and DNS request type (A, AAAA, PTR, etc) |
| blocky_request_duration_ms_bucket | Request duration histogram, partitioned by response type (Blocked, cached, etc) |
| blocky_response_total | Number of responses, partitioned by response type (Blocked, cached, etc), DNS response code, and reason |
| blocky_blocking_enabled | 1 if blocking is enabled, 0 otherwise |
| blocky_cache_entry_count | Number of entries in cache |
| blocky_cache_hit_count / blocky_cache_miss_count | Cache hit/miss counters |
| blocky_prefetch_count | Amount of prefetched DNS responses |
| blocky_prefetch_domain_name_cache_count | Amount of domain names being prefetched |
2022-01-04 21:24:49 +01:00
| blocky_failed_download_count | Number of failed list downloads |
2021-03-05 08:02:00 +01:00
2021-09-08 22:03:06 +02:00
### Grafana dashboard
2021-03-05 08:02:00 +01:00
Example [Grafana ](https://grafana.com/ ) dashboard
definition [as JSON ](https://github.com/0xERR0R/blocky/blob/master/docs/blocky-grafana.json )
or [at grafana.com ](https://grafana.com/grafana/dashboards/13768 )
2021-09-08 22:03:06 +02:00
.
2021-03-05 08:02:00 +01:00
This dashboard shows all relevant statistics and allows enabling and disabling the blocking status.
2021-09-08 22:03:06 +02:00
### Grafana configuration
2021-03-05 08:02:00 +01:00
Please install `grafana-piechart-panel` and
set [disable-sanitize-html ](https://grafana.com/docs/grafana/latest/installation/configuration/#disable-sanitize-html )
in config or as env to use control buttons to enable/disable the blocking status.
2021-09-08 22:03:06 +02:00
### Grafana and Prometheus example project
2021-03-05 08:02:00 +01:00
This [repo ](https://github.com/0xERR0R/blocky-grafana-prometheus-example ) contains example docker-compose.yml with
blocky, prometheus (with configured scraper for blocky) and grafana with prometheus datasource.
2021-09-08 22:03:06 +02:00
## MySQL / MariaDB
If database query logging is activated (see [Query logging ](configuration.md#query-logging )), you can use following
Grafana Dashboard [as JSON ](https://github.com/0xERR0R/blocky/blob/master/docs/blocky-query-grafana.json )
or [at grafana.com ](https://grafana.com/grafana/dashboards/14980 )
.
Please define the MySQL source in Grafana, which points to the database with blocky's log entries.
2022-09-19 21:24:52 +02:00
## Postgres
The JSON for a Grafana dashboard equivalent to the MySQL/MariaDB version is located [here ](https://github.com/0xERR0R/blocky/blob/master/docs/blocky-query-grafana-postgres.json )
2021-03-05 08:02:00 +01:00
--8< -- " docs / includes / abbreviations . md "
