mirror of
https://github.com/coredns/coredns.git
synced 2025-11-26 13:44:05 -05:00
427aed6f5b
* doc update Go through all README and fix mistakes, extend example and let more corefile snippets be test for validity. * Cant use spefic addr in test
26 lines
691 B
Markdown
26 lines
691 B
Markdown
# health
|
|
|
|
*health* enables a simple health check endpoint. By default, it listens on port 8080.
|
|
|
|
## Syntax
|
|
|
|
~~~
|
|
health [ADDRESS]
|
|
~~~
|
|
|
|
Optionally takes an address; the default is `:8080`. The health path is fixed to `/health`. The
|
|
health endpoint returns a 200 response code and the word "OK" when CoreDNS is healthy. It returns
|
|
a 503. *health* 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.
|
|
|
|
## Examples
|
|
|
|
Run another health endpoint on http://localhost:8091.
|
|
|
|
~~~ corefile
|
|
. {
|
|
health localhost:8091
|
|
}
|
|
~~~
|