TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

plugin/health: doc updates (#1582)

Browse source 
Fixes #1564
This commit is contained in:
Miek Gieben 2018-03-01 18:32:15 -08:00 • committed by GitHub
parent 7b93ce2ec1
commit a131c22d24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
plugin/health/README.md
View file

@ -6,7 +6,9 @@
## Description
By enabling *health* any plugin that implements it will be queried for it's health. The combined
By enabling *health* any plugin that implements
[healt.Healther interface](https://godoc.org/github.com/coredns/coredns/plugin/health#Healther)
will be queried for it's health. The combined
health is exported, by default, on port 8080/health .
## Syntax
@ -42,7 +44,7 @@ If monitoring is enabled (via the *prometheus* directive) then the following met
* `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.
CoreDNS process is having trouble keeping up with its query load.
## Examples

10
plugin/health/healther.go
View file

@ -1,11 +1,9 @@
package health
// 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.
// Healther interface needs to be implemented by each plugin willing to provide
// healthhceck information to the health plugin. Note this method should return
// quickly, i.e. just checking a boolean status, as it is called every second
// from the health plugin.
type Healther interface {
// Health returns a boolean indicating the health status of a plugin.
// False indicates unhealthy.