README
¶
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 plugin that exports health information. If any of the
plugin signals that it is unhealthy, the server will go unhealthy too. Each plugin that
supports health checks has a section "Health" in their README.
Examples
Run another health endpoint on http://localhost:8091.
health localhost:8091
Documentation
¶
Overview ¶
Package health implements an HTTP handler that responds to health checks.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Healther ¶
type Healther interface { // Health returns a boolean indicating the health status of a plugin. // False indicates unhealthy. Health() bool }
Healther interface needs to be implemented by each plugin willing to provide healthhceck information to the health plugin. As a second step the plugin needs to registered against the health plugin, by addding it to healthers map. Note this method should return quickly, i.e. just checking a boolean status, as it is called every second from the health plugin.