Files
coredns/middleware/metrics/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

# prometheus
2016-04-14 07:00:16 +01:00
This module enables prometheus metrics for CoreDNS. The default location for the metrics is
2016-04-28 10:44:47 +00:00
`localhost:9153`. The metrics path is fixed to `/metrics`.
The following metrics are exported:
* coredns_dns_request_count_total
* coredns_dns_request_duration_seconds
2016-06-23 11:21:12 +01:00
* coredns_dns_request_size_bytes
* coredns_dns_request_do_count_total
2016-06-25 18:12:13 +01:00
* coredns_dns_request_type_count_total
* coredns_dns_response_size_bytes
* coredns_dns_response_rcode_count_total
2016-04-14 07:00:16 +01:00
Each counter has a label `zone` which is the zonename used for the request/response. and a label
2016-06-23 11:21:12 +01:00
`qtype` which old the query type. The `dns_request_count_total` has extra labels: `proto` which
holds the transport of the response ("udp" or "tcp") and the address family of the transport (1
2016-06-25 18:12:13 +01:00
= IP (IP version 4), 2 = IP6 (IP version 6)). And `type_count_total` hold a per RR type counter, it
holds the most common ones (A, AAAA, MX, SOA, CNAME, PTR, TXT, NS, SRV, DS, DNSKEY, RRSIG, NSEC,
NSEC3) and "other" which lumps together all other types.
2016-06-23 11:21:12 +01:00
The `response_rcode_count_total` has an extra label `rcode` which holds the rcode of the response.
The `*_size_bytes` counters also hold the protocol in the `proto` label ("udp" or "tcp").
2016-04-14 07:00:16 +01:00
If monitoring is enabled queries that do not enter the middleware chain are exported under the fake
domain "dropped" (without a closing dot).
Restarting CoreDNS will stop the monitoring. This is a bug. Also [this upstream
Caddy bug](https://github.com/mholt/caddy/issues/675).
## Syntax
~~~
prometheus
~~~
For each zone that you want to see metrics for.
It optionally takes an address where the metrics are exported, the default
2016-04-28 10:44:47 +00:00
is `localhost:9153`. The metrics path is fixed to `/metrics`.
## Examples