README
¶
example
Name
example - prints "example" after a query is handled.
Description
The example plugin prints "example" on every query that got 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
Put this early in the plugin list, so that example is executed before any of the other plugins.
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
}
Or without any external connectivity:
. {
whoami
example
}
Also See
See the manual.
Documentation
¶
Overview ¶
Package example is a CoreDNS plugin that prints "example" to stdout on every packet received.
It serves as an example CoreDNS plugin with numerous code comments.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EdgeCDNXPrefixList ¶
type EdgeCDNXPrefixList struct {
Next plugin.Handler
Routing *EdgeCDNXPrefixListRouting
Sync *sync.RWMutex
InformerSynced func() bool
}
Example is an example plugin to show how to write a plugin.
func (EdgeCDNXPrefixList) Name ¶
func (e EdgeCDNXPrefixList) Name() string
Name implements the Handler interface.
func (EdgeCDNXPrefixList) Ready ¶
func (e EdgeCDNXPrefixList) Ready() bool
Ready implements the ready.Readiness interface, once this flips to true CoreDNS assumes this plugin is ready for queries; it is not checked again.
type EdgeCDNXPrefixListResponseWriter ¶
type EdgeCDNXPrefixListResponseWriter struct {
}
type PrefixTreeEntry ¶
type ResponsePrinter ¶
type ResponsePrinter struct {
dns.ResponseWriter
}
ResponsePrinter wrap a dns.ResponseWriter and will write example to standard output when WriteMsg is called.
func NewResponsePrinter ¶
func NewResponsePrinter(w dns.ResponseWriter) *ResponsePrinter
NewResponsePrinter returns ResponseWriter.
Source Files