mirror of
https://github.com/coredns/coredns.git
synced 2025-11-03 18:53:13 -05:00
41 lines
1.1 KiB
Groff
41 lines
1.1 KiB
Groff
|
.\" generated with Ronn/v0.7.3
|
||
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||
|
|
.
|
||
|
|
.TH "COREDNS\-HEALTH" "7" "January 2018" "CoreDNS" "CoreDNS plugins"
|
||
|
|
.
|
||
|
|
.SH "NAME"
|
||
|
|
\fIhealth\fR \- enables a health check endpoint\.
|
||
|
|
.
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
By enabling \fIhealth\fR any plugin that implements it will be queried for it\'s health\. The combined health is exported, by default, on port 8080/health \.
|
||
|
|
.
|
||
|
|
.SH "SYNTAX"
|
||
|
|
.
|
||
|
|
.nf
|
||
|
|
|
||
|
|
health [ADDRESS]
|
||
|
|
.
|
||
|
|
.fi
|
||
|
|
.
|
||
|
|
.P
|
||
|
|
Optionally takes an address; the default is \fB:8080\fR\. The health path is fixed to \fB/health\fR\. The health endpoint returns a 200 response code and the word "OK" when CoreDNS is healthy\. It returns a 503\. \fIhealth\fR periodically (1s) polls plugin that exports health information\. If any of the plugin signals that it is unhealthy, the server will go unhealthy too\. Each plugin that supports health checks has a section "Health" in their README\.
|
||
|
|
.
|
||
|
|
.SH "PLUGINS"
|
||
|
|
Any plugin that implements the Healther interface will be used to report health\.
|
||
|
|
.
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
Run another health endpoint on http://localhost:8091\.
|
||
|
|
.
|
||
|
|
.IP "" 4
|
||
|
|
.
|
||
|
|
.nf
|
||
|
|
|
||
|
|
\&\. {
|
||
|
|
health localhost:8091
|
||
|
|
}
|
||
|
|
.
|
||
|
|
.fi
|
||
|
|
.
|
||
|
|
.IP "" 0
|
||
|
|
|