middleware/health/README.md

# health

This module enables a simple health check.

By default it will listen on port 8080.

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
A health middleware Start http handler on port 8080 and return OK. Also add some documentation fixes for the prometheus middleware. 2016-04-06 09:21:46 +01:00			`# health`

			`This module enables a simple health check.`

Fix default address typo in health README 2016-04-13 10:19:09 +00:00			`By default it will listen on port 8080.`
A health middleware Start http handler on port 8080 and return OK. Also add some documentation fixes for the prometheus middleware. 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`
			`~~~`

			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`