aboutsummaryrefslogtreecommitdiff
path: root/plugin.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2019-03-07 20:35:16 +0000
committerGravatar GitHub <noreply@github.com> 2019-03-07 20:35:16 +0000
commitdb0b16b615c5397628f392de6dd131d4cbc148d9 (patch)
treee74cb806287c5f61f2c915269de1e0225b558a2f /plugin.md
parent2b7e84a076e38cfc67a69b2c0c8dec106585d4b9 (diff)
downloadcoredns-db0b16b615c5397628f392de6dd131d4cbc148d9.tar.gz
coredns-db0b16b615c5397628f392de6dd131d4cbc148d9.tar.zst
coredns-db0b16b615c5397628f392de6dd131d4cbc148d9.zip
Add *ready* plugin (#2616)
Add a ready plugin that allows plugin to signal when they are ready. Once a plugin is ready it is not queried again. This uses same mechanism as the health plugin: each plugin needs to implement an interface. Implement readines for the *erratic* plugin to aid in testing. Add README.md and tests moduled after the health plugin; which will be relegated to just providing process health. In similar vein to health this is a process wide setting. With this Corefile: ~~~ . { erratic whoami ready } bla { erratic whoami } ~~~ ready will lead to: ~~~ sh % curl localhost:8181/ready % dig @localhost -p 1053 mx example.org % curl localhost:8181/ready OK% ~~~ Meanwhile CoreDNS logs: ~~~ .:1053 bla.:1053 2019-02-26T20:59:07.137Z [INFO] CoreDNS-1.3.1 2019-02-26T20:59:07.137Z [INFO] linux/amd64, go1.11.4, CoreDNS-1.3.1 linux/amd64, go1.11.4, 2019-02-26T20:59:11.415Z [INFO] plugin/ready: Still waiting on: "erratic" 2019-02-26T20:59:13.510Z [INFO] plugin/ready: Still waiting on: "erratic" ~~~ *ready* can be used in multiple server blocks and will do the right thing; query all those plugins from all server blocks for readiness. This does a similar thing to the prometheus plugin. Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'plugin.md')
-rw-r--r--plugin.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/plugin.md b/plugin.md
index ff4ecbf0a..81855ec38 100644
--- a/plugin.md
+++ b/plugin.md
@@ -57,8 +57,13 @@ server.
When exporting metrics the *Namespace* should be `plugin.Namespace` (="coredns"), and the
*Subsystem* should be the name of the plugin. The README.md for the plugin should then also contain
- a *Metrics* section detailing the metrics. If the plugin supports dynamic health reporting it
- should also have *Health* section detailing on some of its inner workings.
+a *Metrics* section detailing the metrics.
+
+If the plugin supports dynamic health reporting it should also have *Health* section detailing on
+some of its inner workings.
+
+If the plugins supports signalling readiness it should have a *Ready* section detailing how it
+works.
## Documentation