2016-04-06 09:21:46 +01:00
|
|
|
# health
|
|
|
|
|
|
|
|
|
|
This module enables a simple health check.
|
|
|
|
|
|
2016-04-13 10:19:09 +00:00
|
|
|
By default it will listen on port 8080.
|
2016-04-06 09:21:46 +01:00
|
|
|
|
|
|
|
|
Restarting CoreDNS will stop the health checking. This is a bug. Also [this upstream
|
|
|
|
|
Caddy bug](https://github.com/mholt/caddy/issues/675).
|
|
|
|
|
|
|
|
|
|
## Syntax
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
health
|
|
|
|
|
~~~
|
|
|
|
|
|
2016-08-22 14:17:21 -07:00
|
|
|
Optionally takes an address; the default is `:8080`. The health path is fixed to `/health`. It
|
|
|
|
|
will just return "OK" when CoreDNS is healthy.
|
2016-04-06 09:21:46 +01:00
|
|
|
|
|
|
|
|
This middleware only needs to be enabled once.
|
|
|
|
|
|
|
|
|
|
## Examples
|
2016-04-28 10:26:58 +01:00
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
health localhost:8091
|
|
|
|
|
~~~
|
