diff options
Diffstat (limited to 'plugin')
| -rw-r--r-- | plugin/metadata/README.md | 45 |
1 files changed, 21 insertions, 24 deletions
diff --git a/plugin/metadata/README.md b/plugin/metadata/README.md index 32f58baa8..aaf3375b1 100644 --- a/plugin/metadata/README.md +++ b/plugin/metadata/README.md @@ -2,13 +2,21 @@ ## Name -*metadata* - enable a metadata collector. +*metadata* - enable a meta data collector. ## Description -By enabling *metadata* any plugin that implements [metadata.Provider interface](https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider) will be called for each DNS query, at being of the process for that query, in order to add it's own Metadata to context. The metadata collected will be available for all plugins handler, via the Context parameter provided in the ServeDNS function. -Metadata plugin is automatically adding the so-called default medatada (extracted from the query) to the context. Those default metadata are: {qname}, {qtype}, {client_ip}, {client_port}, {protocol}, {server_ip}, {server_port} +By enabling *metadata* any plugin that implements [metadata.Provider +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 it's own Metadata to +context. +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. + +TODO: write about naming of the keys (labels). +TODO: write about extracting and using ## Syntax @@ -16,32 +24,21 @@ Metadata plugin is automatically adding the so-called default medatada (extracte metadata [ZONES... ] ~~~ +* **ZONES** zones metadata should be invoked for. + ## Plugins -metadata.Provider interface needs to be implemented by each plugin willing to provide metadata information for other plugins. It will be called by metadata and gather the information from all plugins in context. -Note: this method should work quickly, because it is called for every request -from the metadata plugin. -If **ZONES** is specified then metadata add is limited by zones. Metadata is added to every context going through metadata.Provider if **ZONES** are not specified. +metadata.Provider interface needs to be implemented by each plugin willing to provide metadata +information for other plugins. It will be called by metadata and gather the information from all +plugins in context. +Note: this method should work quickly, because it is called for every request. ## Examples -Enable metadata for all requests. Rewrite uses one of the provided by default metadata variables. +There are currently no in tree plugins that write or use metadata. -~~~ corefile -. { - metadata - rewrite edns0 local set 0xffee {client_ip} - forward . 8.8.8.8:53 -} -~~~ +## Also See -Add metadata for all requests within `example.org.`. Rewrite uses one of provided by default metadata variables. Any other requests won't have metadata. - -~~~ corefile -. { - metadata example.org - rewrite edns0 local set 0xffee {client_ip} - forward . 8.8.8.8:53 -} -~~~ +The [Provider interface](https://godoc.org/github.com/coredns/coredns/plugin/metadata#Provider) and +the [package level](https://godoc.org/github.com/coredns/coredns/plugin/metadata) documentation. |