Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
C
Coredns
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Railgun
Coredns
Commits
a131c22d
Commit
a131c22d
authored
Mar 01, 2018
by
Miek Gieben
Committed by
GitHub
Mar 01, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
plugin/health: doc updates (#1582)
Fixes #1564
parent
7b93ce2e
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
8 additions
and
8 deletions
+8
-8
plugin/health/README.md
plugin/health/README.md
+4
-2
plugin/health/healther.go
plugin/health/healther.go
+4
-6
No files found.
plugin/health/README.md
View file @
a131c22d
...
@@ -6,7 +6,9 @@
...
@@ -6,7 +6,9 @@
## Description
## 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 .
health is exported, by default, on port 8080/health .
## Syntax
## Syntax
...
@@ -42,7 +44,7 @@ If monitoring is enabled (via the *prometheus* directive) then the following met
...
@@ -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
*
`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
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
## Examples
...
...
plugin/health/healther.go
View file @
a131c22d
package
health
package
health
// Healther interface needs to be implemented by each plugin willing to
// Healther interface needs to be implemented by each plugin willing to provide
// provide healthhceck information to the health plugin. As a second step
// healthhceck information to the health plugin. Note this method should return
// the plugin needs to registered against the health plugin, by addding
// quickly, i.e. just checking a boolean status, as it is called every second
// it to healthers map. Note this method should return quickly, i.e. just
// from the health plugin.
// checking a boolean status, as it is called every second from the health
// plugin.
type
Healther
interface
{
type
Healther
interface
{
// Health returns a boolean indicating the health status of a plugin.
// Health returns a boolean indicating the health status of a plugin.
// False indicates unhealthy.
// False indicates unhealthy.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment