diff options
| author |  Miek Gieben <miek@miek.nl>
| 2018-03-01 18:32:15 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2018-03-01 18:32:15 -0800 |
| commit | a131c22d24d7d035d5da4d0067439dae367a5c5b (patch) | |
| tree | 04853aa1cd0e2e7eebcc940129f5bbcce77dc579 | |
| parent | 7b93ce2ec1d70e64176790edd4a8b5a58fc8fee4 (diff) | |
| download | coredns-a131c22d24d7d035d5da4d0067439dae367a5c5b.tar.gz coredns-a131c22d24d7d035d5da4d0067439dae367a5c5b.tar.zst coredns-a131c22d24d7d035d5da4d0067439dae367a5c5b.zip | |
plugin/health: doc updates (#1582)
Fixes #1564
| -rw-r--r-- | plugin/health/README.md | 6 | ||||
| -rw-r--r-- | plugin/health/healther.go | 10 |
2 files changed, 8 insertions, 8 deletions
diff --git a/plugin/health/README.md b/plugin/health/README.md index 4389f6353..b8b9063a1 100644 --- a/plugin/health/README.md +++ b/plugin/health/README.md @@ -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 diff --git a/plugin/health/healther.go b/plugin/health/healther.go index e61437978..8bb6c907c 100644 --- a/plugin/health/healther.go +++ b/plugin/health/healther.go @@ -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. |