aboutsummaryrefslogtreecommitdiff
path: root/middleware.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2017-08-27 21:33:38 +0100
committerGravatar Yong Tang <yong.tang.github@outlook.com> 2017-08-27 13:33:38 -0700
commit558f4bea41e0493dd4b0e6d0f73b0220a39d1e67 (patch)
treee735d03f6860db25e09d552ce0b782ea131f68bc /middleware.md
parent9c56805d389dac89f7d5f5fc5b05407294ba3157 (diff)
downloadcoredns-558f4bea41e0493dd4b0e6d0f73b0220a39d1e67.tar.gz
coredns-558f4bea41e0493dd4b0e6d0f73b0220a39d1e67.tar.zst
coredns-558f4bea41e0493dd4b0e6d0f73b0220a39d1e67.zip
mw/health: poll other middleware (#976)
This add the infrastructure to let other middleware report their health status back to the health middleware. A health.Healther interface is introduced and a middleware needs to implement that. A middleware that supports healthchecks is statically configured. Every second each supported middleware is queried and the global health state is updated. Actual tests have been disabled as no other middleware implements this at the moment.
Diffstat (limited to 'middleware.md')
-rw-r--r--middleware.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/middleware.md b/middleware.md
index ee4181c2b..f946e63e5 100644
--- a/middleware.md
+++ b/middleware.md
@@ -40,7 +40,8 @@ See a couple of blog posts on how to write and add middleware to CoreDNS:
When exporting metrics the *Namespace* should be `middleware.Namespace` (="coredns"), and the
*Subsystem* should be the name of the middleware. The README.md for the middleware should then
-also contain a *Metrics* section detailing the metrics.
+also contain a *Metrics* section detailing the metrics. If the middleware supports dynamic health
+reporting it should also have *Health* section detailing on its inner workings.
## Documentation