mirror of
https://github.com/coredns/coredns.git
synced 2025-12-08 03:15:41 -05:00
A health middleware
Start http handler on port 8080 and return OK. Also add some documentation fixes for the prometheus middleware.
This commit is contained in:
21
middleware/health/README.md
Normal file
21
middleware/health/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# health
|
||||
|
||||
This module enables a simple health check.
|
||||
|
||||
By default it will listen on port 9180.
|
||||
|
||||
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
|
||||
~~~
|
||||
|
||||
It optionally takes an address, the default is `:8080`. The health path is fixed to `/health`. It
|
||||
will just return "OK", when CoreDNS is healthy.
|
||||
|
||||
This middleware only needs to be enabled once.
|
||||
|
||||
## Examples
|
||||
Reference in New Issue
Block a user