coredns/middleware/metrics
Miek Gieben faf83b00dd docs: rewrite using manpage style (#327)
This still needs cleanup, but this is a first pass the cleans some
cruft and documents our style (in middleware.md) and makes all the
docs match that style.
2016-10-10 20:13:22 +01:00
..
handler.go middleware/metrics: fix crash on startup (#318) 2016-10-04 11:05:04 +01:00
metrics.go middleware/metrics: fix crash on startup (#318) 2016-10-04 11:05:04 +01:00
README.md docs: rewrite using manpage style (#327) 2016-10-10 20:13:22 +01:00
setup.go middleware/metrics: fix crash on startup (#318) 2016-10-04 11:05:04 +01:00
setup_test.go tests: clean up output 2016-10-08 16:44:43 +01:00

prometheus

This module enables prometheus metrics for CoreDNS. The default location for the metrics is localhost:9153. The metrics path is fixed to /metrics.

The following metrics are exported:

  • coredns_dns_request_count_total{zone, proto, family}
  • coredns_dns_request_duration_milliseconds{zone}
  • coredns_dns_request_size_bytes{zone,, proto}
  • coredns_dns_request_transfer_size_bytes{zone,, proto}
  • coredns_dns_request_do_count_total{zone}
  • coredns_dns_request_type_count_total{zone, type}
  • coredns_dns_response_size_bytes{zone, proto}
  • coredns_dns_response_transfer_size_bytes{zone, proto}
  • coredns_dns_response_rcode_count_total{zone, rcode}

Each counter has a label zone which is the zonename used for the request/response.

Extra labels used are:

  • proto which holds the transport of the response ("udp" or "tcp")
  • The address family (family) of the transport (1 = IP (IP version 4), 2 = IP6 (IP version 6)).
  • type which holds the query type. It holds most common types (A, AAAA, MX, SOA, CNAME, PTR, TXT, NS, SRV, DS, DNSKEY, RRSIG, NSEC, NSEC3, IXFR, AXFR and ANY) and "other" which lumps together all other types.
  • The response_rcode_count_total has an extra label rcode which holds the rcode of the response.

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.

Syntax

prometheus [ADDRESS]

For each zone that you want to see metrics for.

It optionally takes an address to which the metrics are exported; the default is localhost:9153. The metrics path is fixed to /metrics.

Examples