Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 16:24:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

plugin/health: clarify use a bit (#2791)

Browse Source 
Make clearer how health works and that is it process wide.

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-04-18 17:21:02 +01:00
committed by Yong Tang
parent 5aafa987b2
commit 98c7a6effb
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
plugin/health/README.md
View File

@@ -29,7 +29,7 @@ health [ADDRESS] {
* Where `lameduck` will make the process unhealthy then *wait* for **DURATION** before the process * Where `lameduck` will make the process unhealthy then *wait* for **DURATION** before the process
shuts down. 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: wide). If you really need multiple endpoints, you must run health endpoints on different ports:
~~~ corefile ~~~ corefile
@@ -44,13 +44,15 @@ net {
} }
~~~ ~~~
Doing this is supported but both endponts ":8080" and ":8081" will export the exact same health.
## Metrics ## Metrics
If monitoring is enabled (via the *prometheus* directive) then the following metric is exported: 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 * `coredns_health_request_duration_seconds{}` - duration to process a HTTP query to the local
be a local operation it should be fast. A (large) increases in this duration indicates the `/health` endpoint. As this a local operation it should be fast. A (large) increase in this
CoreDNS process is having trouble keeping up with its query load. 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 Note that this metric *does not* have a `server` label, because being overloaded is a symptom of
the running process, *not* a specific server. the running process, *not* a specific server.