Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 16:24:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

Making README consistent, fixing "meta data" (#3244)

Browse Source
This commit is contained in:
Cricket Liu
2019-09-08 00:23:20 -07:00
committed by Miek Gieben
parent 878f906854
commit 31fd9328cd
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
plugin/metadata/README.md
View File

@@ -2,25 +2,25 @@
## Name ## Name
*metadata* - enable a meta data collector. *metadata* - enables a metadata collector.
## Description ## Description
By enabling *metadata* any plugin that implements [metadata.Provider By enabling *metadata* any plugin that implements [metadata.Provider
interface](https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider) will be called for interface](https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider) will be called for
each DNS query, at beginning of the process for that query, in order to add its own meta data to each DNS query, at the beginning of the process for that query, in order to add its own metadata to
context. context.
The meta data collected will be available for all plugins, via the Context parameter provided in the The metadata collected will be available for all plugins, via the Context parameter provided in the
ServeDNS function. The package (code) documentation has examples on how to inspect and retrieve ServeDNS function. The package (code) documentation has examples on how to inspect and retrieve
metadata a plugin might be interested in. metadata a plugin might be interested in.
The meta data is added by setting a label with a value in the context. These labels should be named The metadata is added by setting a label with a value in the context. These labels should be named
`plugin/NAME`, where **NAME** is something descriptive. The only hard requirement the *metadata* `plugin/NAME`, where **NAME** is something descriptive. The only hard requirement the *metadata*
plugin enforces is that the labels contains a slash. See the documentation for plugin enforces is that the labels contain a slash. See the documentation for
`metadata.SetValueFunc`. `metadata.SetValueFunc`.
The value stored is a string. The empty string signals "no meta data". See the documentation for The value stored is a string. The empty string signals "no metadata". See the documentation for
`metadata.ValueFunc` on how to retrieve this. `metadata.ValueFunc` on how to retrieve this.
## Syntax ## Syntax