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

Doc update (#2792)

Browse Source 
* Fix spelling in coredns.1 and corefile.7 md files
* Run make -f Makefile.doc

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-04-21 22:38:40 +01:00
committed by Yong Tang
parent 98c7a6effb
commit 2c418b9fd5
10 changed files with 112 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
man/coredns-health.7
View File

@@ -1,16 +1,16 @@
.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS-HEALTH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-HEALTH" 7 "April 2019" "CoreDNS" "CoreDNS Plugins"
.SH NAME
.SH "NAME"
.PP
\fIhealth\fP - enables a health check endpoint.
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
Enabled process wide health endpoint. When CoreDNS is up and running this returns a 200 OK http
status code. The health is exported, by default, on port 8080/health .
.SH SYNTAX
.SH "SYNTAX"
.PP
.RS
@@ -44,7 +44,7 @@ shuts down.
.PP
If you have multiple Server Blocks, \fIhealth\fP should only be enabled in one of them (as it is process
If you have multiple Server Blocks, \fIhealth\fP 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:
.PP
@@ -64,21 +64,24 @@ net {
.fi
.RE
.SH METRICS
.PP
Doing this is supported but both endponts ":8080" and ":8081" will export the exact same health.
.SH "METRICS"
.PP
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported:
.IP \(bu 4
\fB\fCcoredns_health_request_duration_seconds{}\fR - 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.
\fB\fCcoredns_health_request_duration_seconds{}\fR - duration to process a HTTP query to the local
\fB\fC/health\fR 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.
.PP
Note that this metric \fIdoes not\fP have a \fB\fCserver\fR label, because being overloaded is a symptom of
the running process, \fInot\fP a specific server.
.SH EXAMPLES
.SH "EXAMPLES"
.PP
Run another health endpoint on http://localhost:8091
\[la]http://localhost:8091\[ra].
@@ -110,7 +113,7 @@ Set a lameduck duration of 1 second:
.fi
.RE
.SH BUGS
.SH "BUGS"
.PP
When reloading, the health handler is stopped before the new server instance is started. If that
new server fails to start, then the initial server instance is still available and DNS queries still