middleware/health/README.md

# health

This module enables a simple health check endpoint.
By default it will listen on port 8080.

## Syntax

~~~
health [ADDRESS]
~~~

Optionally takes an address; the default is `:8080`. The health path is fixed to `/health`. It
will just return "OK" when CoreDNS is healthy, which currently mean: it is up and running.

This middleware only needs to be enabled once.

## Examples

~~~
health localhost:8091
~~~
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`

docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`This module enables a simple health check endpoint.`
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
			`## Syntax`

			`~~~`
docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`health [ADDRESS]`
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			`~~~`

Update README.md Grammatical fixes. 2016-08-22 14:17:21 -07:00			Optionally takes an address; the default is `:8080`. The health path is fixed to `/health`. It
docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`will just return "OK" when CoreDNS is healthy, which currently mean: it is up and running.`
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
			`This middleware only needs to be enabled once.`

			`## Examples`
pprof middleware (#138) Add pprof middleware, enabled by pprof directive. 2016-04-28 10:26:58 +01:00
			`~~~`
			`health localhost:8091`
			`~~~`