aboutsummaryrefslogtreecommitdiff
path: root/plugin
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2019-04-18 17:21:02 +0100
committerGravatar Yong Tang <yong.tang.github@outlook.com> 2019-04-18 09:21:02 -0700
commit98c7a6effb9b0048fc02024aa8ed85aa1cbca443 (patch)
treec453aa4c74d4992b927a08f8472bef095d9e48d6 /plugin
parent5aafa987b2d7127a2eef9d67788d9b338cff54d2 (diff)
downloadcoredns-98c7a6effb9b0048fc02024aa8ed85aa1cbca443.tar.gz
coredns-98c7a6effb9b0048fc02024aa8ed85aa1cbca443.tar.zst
coredns-98c7a6effb9b0048fc02024aa8ed85aa1cbca443.zip
plugin/health: clarify use a bit (#2791)
Make clearer how health works and that is it process wide. Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'plugin')
-rw-r--r--plugin/health/README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/plugin/health/README.md b/plugin/health/README.md
index 68afeac06..908d34f4f 100644
--- a/plugin/health/README.md
+++ b/plugin/health/README.md
@@ -29,7 +29,7 @@ health [ADDRESS] {
* Where `lameduck` will make the process unhealthy then *wait* for **DURATION** before the process
shuts down.
-If you have multiple Server Blocks, *health* should only be enabled in one of them (as it is process
+If you have multiple Server Blocks, *health* can only be enabled in one of them (as it is process
wide). If you really need multiple endpoints, you must run health endpoints on different ports:
~~~ corefile
@@ -44,13 +44,15 @@ net {
}
~~~
+Doing this is supported but both endponts ":8080" and ":8081" will export the exact same health.
+
## Metrics
If monitoring is enabled (via the *prometheus* directive) then the following metric is exported:
-* `coredns_health_request_duration_seconds{}` - duration to process a /health query. As this should
- be a local operation it should be fast. A (large) increases in this duration indicates the
- CoreDNS process is having trouble keeping up with its query load.
+ * `coredns_health_request_duration_seconds{}` - duration to process a HTTP query to the local
+ `/health` endpoint. As this a local operation it should be fast. A (large) increase in this
+ duration indicates the CoreDNS process is having trouble keeping up with its query load.
Note that this metric *does not* have a `server` label, because being overloaded is a symptom of
the running process, *not* a specific server.