README
¶
health
Name
health - enables a health check endpoint.
Description
By enabling health any plugin that implements it will be queried for it's health. The combined health is exported, by default, on port 8080/health .
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.
More options can be set with this extended syntax:
health [ADDRESS] {
lameduck DURATION
}
- Where
lameduckwill make the process unhealthy then wait for DURATION before the process shuts down.
Plugins
Any plugin that implements the Healther interface will be used to report health.
Metrics
If monitoring is enabled (via the prometheus directive) then the following metric is exported:
coredns_health_request_duration_seconds{}- duration to process a /health query. As this should be a local operation it should be fast. A (large) increases in this duration indicates the CoreDNS process is having trouble keeping up.
Examples
Run another health endpoint on http://localhost:8091.
. {
health localhost:8091
}
Set a lameduck duration of 1 second:
. {
health localhost:8091 {
lameduck 1s
}
}
Documentation
¶
Overview ¶
Package health implements an HTTP handler that responds to health checks.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // HealthDuration is the metric used for exporting how fast we can retrieve the /health endpoint. HealthDuration = prometheus.NewHistogram(prometheus.HistogramOpts{ Namespace: plugin.Namespace, Subsystem: "health", Name: "request_duration_seconds", Buckets: plugin.TimeBuckets, Help: "Histogram of the time (in seconds) each request took.", }) )
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.
Source Files