Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-11-26 13:44:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

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
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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.