Files
coredns/plugin/health/README.md
Miek Gieben 52b49f4838 plugin/health: implement dyn health checks (#1214)
Implement health.Healther in erratic and kubernetes plugin. The
kubernetes' healtcheck is only performed on startup - i.e. turn
healthy after the initial loading.

Erratic follow the drop count: every query%drop turns the healthcheck
unhealthy.

Fixes: #985
2017-11-13 09:52:40 +00:00

35 lines
787 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.
## Plugins
The following plugins report health to the health plugin:
* erratic
* kubernetes
## Examples
Run another health endpoint on http://localhost:8091.
~~~ corefile
. {
health localhost:8091
}
~~~