forked from rcrowley/go-metrics
-
Notifications
You must be signed in to change notification settings - Fork 1
/
healthcheck.go
48 lines (40 loc) · 1.22 KB
/
healthcheck.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package metrics
// Healthchecks hold an os.Error value describing an arbitrary up/down status.
//
// This is an interface so as to encourage other structs to implement
// the Healthcheck API as appropriate.
type Healthcheck interface {
Check()
Error() error
Healthy()
Unhealthy(error)
}
// The standard implementation of a Healthcheck stores the status and a
// function to call to update the status.
type StandardHealthcheck struct {
err error
f func(Healthcheck)
}
// Force the compiler to check that StandardHealthcheck implements Healthcheck.
var _ Healthcheck = &StandardHealthcheck{}
// Create a new healthcheck, which will use the given function to update
// its status.
func NewHealthcheck(f func(Healthcheck)) *StandardHealthcheck {
return &StandardHealthcheck{nil, f}
}
// Update the healthcheck's status.
func (h *StandardHealthcheck) Check() {
h.f(h)
}
// Return the healthcheck's status, which will be nil if it is healthy.
func (h *StandardHealthcheck) Error() error {
return h.err
}
// Mark the healthcheck as healthy.
func (h *StandardHealthcheck) Healthy() {
h.err = nil
}
// Mark the healthcheck as unhealthy. The error should provide details.
func (h *StandardHealthcheck) Unhealthy(err error) {
h.err = err
}