Clebert Suconic 773b4b612c Adding some README information on how to consume this example

I also added some cross references to the documentation and blogs where I could find the relevant information.

Signed-off-by: Clebert Suconic <clebertsuconic@apache.org>

2020-01-28 15:56:59 -05:00

1.7 KiB

Raw Blame History

example

Name

example - prints "example" on every query handled.

Description

The example plugin prints "example" on every query that go handled by the server. It serves as documentation for writing CoreDNS plugins.

Compilation

This package will always be compiled as part of CoreDNS and not in a standalone way. It will require you to use go get or as a dependency on plugin.cfg.

The manual will have more information about how to configure and extend the server with external plugins.

A simple way to consume this plugin, is by adding the following on plugin.cfg, and recompile it as detailed on coredns.io.

example:github.com/coredns/example

After this you can compile coredns by:

go generate
go build

Or you can instead use make:

make

Syntax

example

Metrics

If monitoring is enabled (via the prometheus directive) the following metric is exported:

coredns_example_request_count_total{server} - query count to the example plugin.

The server label indicated which server handled the request, see the metrics plugin for details.

Ready

This plugin reports readiness to the ready plugin. It will be immediately ready.

Examples

In this configuration, we forward all queries to 9.9.9.9 and print "example" whenever we receive a query.

. {
  forward . 9.9.9.9
  example
}

Also See

See the manual.

1.7 KiB Raw Blame History