Files
coredns/middleware/cache/README.md
Miek Gieben 219bfd0493 middleware/metrics: cleanup (#355)
* middleware/metrics: add more metrics

middleware/cache:
Add metrics for number of elements in the cache. Also export the total
size. Update README to detail the new metrics.

middleware/metrics

Move metrics into subpackage called "vars". This breaks the import
cycle and is cleaner. This allows vars.Report to be used in the
the dnsserver to log refused queries.

middleware/metrics: tests

Add tests to the metrics framework. The metrics/test subpackage allows
scraping of the local server. Do a few test scrape of the metrics that
are defined in the metrics middleware.

This also allows metrics integration tests to check if the caching and
dnssec middleware export their metrics correctly.

* update README

* typos

* fix tests
2016-10-26 10:01:52 +01:00

1.8 KiB

cache

cache enables a frontend cache.

Syntax

cache [TTL] [ZONES...]
  • TTL max TTL in seconds. If not specified, the maximum TTL will be used which is 1 hour for noerror responses and half an hour for denial of existence ones.
  • ZONES zones it should cache for. If empty, the zones from the configuration block are used.

Each element in the cache is cached according to its TTL (with TTL as the max). For the negative cache, the SOA's MinTTL value is used. A cache can contain up to 10,000 items by default.

If you want more control:

cache [TTL] [ZONES...] {
    success CAPACITY [TTL]
    denial CAPACITY [TTL]
}
  • TTL and ZONES as above.
  • success, override the settings for caching succesful responses, CAPACITY indicates the maximum number of packets we cache before we start evicting (LRU). TTL overrides the cache maximum TTL.
  • denial, override the settings for caching denial of existence responses, CAPACITY indicates the maximum number of packets we cache before we start evicting (LRU). TTL overrides the cache maximum TTL.

There is a third category (error) but those responses are never cached.

The minimum TTL allowed on resource records is 5 seconds.

Metrics

If monitoring is enabled (via the prometheus directive) then the following metrics are exported:

  • coredns_cache_size_guage{type} - total elements in the case, type is either "denial" or "success".
  • coredns_cache_capacity_guage{type} - total capacity of the cache, type is either "denial" or "success".

Examples

Enable caching for all zones, but cap everything to a TTL of 10 seconds:

cache 10

Proxy to Google Public DNS and only cache responses for example.org (or below).

proxy . 8.8.8.8:53
cache example.org