coredns/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`. The
health endpoint returns a 200 response code and the word "OK" when CoreDNS is healthy. It returns
a 503. *health* periodically (1s) polls middleware that exports health information. If any of the
middleware signals that it is unhealthy, the server will go unhealthy too. Each middleware that
supports health checks has a section "Health" in their README.

## Examples

Run another health endpoint on http://localhost:8091.

~~~
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`

mw/health: poll other middleware (#976) This add the infrastructure to let other middleware report their health status back to the health middleware. A health.Healther interface is introduced and a middleware needs to implement that. A middleware that supports healthchecks is statically configured. Every second each supported middleware is queried and the global health state is updated. Actual tests have been disabled as no other middleware implements this at the moment. 2017-08-27 21:33:38 +01:00			`This module enables a simple health check endpoint. 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			`~~~`

mw/health: poll other middleware (#976) This add the infrastructure to let other middleware report their health status back to the health middleware. A health.Healther interface is introduced and a middleware needs to implement that. A middleware that supports healthchecks is statically configured. Every second each supported middleware is queried and the global health state is updated. Actual tests have been disabled as no other middleware implements this at the moment. 2017-08-27 21:33:38 +01:00			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 middleware that exports health information. If any of the`
			`middleware signals that it is unhealthy, the server will go unhealthy too. Each middleware that`
			`supports health checks has a section "Health" in their README.`
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
			`## Examples`
pprof middleware (#138) Add pprof middleware, enabled by pprof directive. 2016-04-28 10:26:58 +01:00
mw/health: poll other middleware (#976) This add the infrastructure to let other middleware report their health status back to the health middleware. A health.Healther interface is introduced and a middleware needs to implement that. A middleware that supports healthchecks is statically configured. Every second each supported middleware is queried and the global health state is updated. Actual tests have been disabled as no other middleware implements this at the moment. 2017-08-27 21:33:38 +01:00			`Run another health endpoint on http://localhost:8091.`

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