mirror of https://github.com/0xERR0R/blocky.git
2.3 KiB
2.3 KiB
Integration in Prometheus / Grafana
Prometheus export
Blocky can optionally export metrics for Prometheus.
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 |
Grafana dashboard
Example Grafana dashboard definition as JSON or at grafana.com .
This dashboard shows all relevant statistics and allows enabling and disabling the blocking status.
Grafana configuration
Please install grafana-piechart-panel
and
set disable-sanitize-html
in config or as env to use control buttons to enable/disable the blocking status.
Grafana and Prometheus example project
This repo contains example docker-compose.yml with blocky, prometheus (with configured scraper for blocky) and grafana with prometheus datasource.
--8<-- "docs/includes/abbreviations.md"