diff options
Diffstat (limited to 'man/coredns-metadata.7')
| -rw-r--r-- | man/coredns-metadata.7 | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/man/coredns-metadata.7 b/man/coredns-metadata.7 index e3598282e..63af5a066 100644 --- a/man/coredns-metadata.7 +++ b/man/coredns-metadata.7 @@ -1,31 +1,31 @@ .\" Generated by Mmark Markdown Processer - mmark.miek.nl -.TH "COREDNS-METADATA" 7 "August 2019" "CoreDNS" "CoreDNS Plugins" +.TH "COREDNS-METADATA" 7 "September 2019" "CoreDNS" "CoreDNS Plugins" .SH "NAME" .PP -\fImetadata\fP - enable a meta data collector. +\fImetadata\fP - enables a metadata collector. .SH "DESCRIPTION" .PP By enabling \fImetadata\fP any plugin that implements metadata.Provider interface \[la]https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider\[ra] 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. .PP -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 metadata a plugin might be interested in. .PP -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 \fB\fCplugin/NAME\fR, where \fBNAME\fP is something descriptive. The only hard requirement the \fImetadata\fP -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 \fB\fCmetadata.SetValueFunc\fR. .PP -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 \fB\fCmetadata.ValueFunc\fR on how to retrieve this. .SH "SYNTAX" |