forked from spiffe/spire
-
Notifications
You must be signed in to change notification settings - Fork 4
/
health.go
227 lines (179 loc) · 5.3 KB
/
health.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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
package health
import (
"context"
"encoding/json"
"errors"
"net"
"net/http"
"sync"
"time"
"github.com/accuknox/spire/pkg/common/telemetry"
"github.com/andres-erbsen/clock"
"github.com/sirupsen/logrus"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
)
const (
// testDialTimeout is the duration to wait for a test dial
testDialTimeout = 30 * time.Second
readyCheckInterval = time.Minute
)
// State is the health state of a subsystem.
type State struct {
// Live is whether or not the subsystem is live (i.e. in a good state
// or in a state it can recover from while remaining alive). Global
// liveness is only reported true if all subsystems report live.
Live bool
// Ready is whether or not the subsystem is ready (i.e. ready to perform
// its function). Global readiness is only reported true if all subsystems
// report ready.
Ready bool
// Subsystems can return whatever details they want here as long as it is
// serializable via json.Marshal.
// LiveDetails are opaque details related to the live check.
LiveDetails interface{}
// ReadyDetails are opaque details related to the live check.
ReadyDetails interface{}
}
// Checkable is the interface implemented by subsystems that the checker uses
// to determine subsystem health.
type Checkable interface {
CheckHealth() State
}
// Checker is responsible for running health checks and serving the healthcheck HTTP paths
type Checker interface {
AddCheck(name string, checkable Checkable) error
}
type ServableChecker interface {
Checker
ListenAndServe(ctx context.Context) error
}
func NewChecker(config Config, log logrus.FieldLogger) ServableChecker {
l := log.WithField(telemetry.SubsystemName, "health")
c := &checker{
config: config,
log: l,
cache: newCache(l, clock.New()),
}
// Start HTTP server if ListenerEnabled is true
if config.ListenerEnabled {
handler := http.NewServeMux()
handler.HandleFunc(config.getReadyPath(), c.readyHandler)
handler.HandleFunc(config.getLivePath(), c.liveHandler)
c.server = &http.Server{
Addr: config.getAddress(),
Handler: handler,
ReadHeaderTimeout: time.Second * 10,
}
}
return c
}
type checker struct {
config Config
server *http.Server
mutex sync.Mutex // Mutex protects non-threadsafe
log logrus.FieldLogger
cache *cache
}
func (c *checker) AddCheck(name string, checkable Checkable) error {
c.mutex.Lock()
defer c.mutex.Unlock()
return c.cache.addCheck(name, checkable)
}
func (c *checker) ListenAndServe(ctx context.Context) error {
c.mutex.Lock()
defer c.mutex.Unlock()
if err := c.cache.start(ctx); err != nil {
return err
}
var wg sync.WaitGroup
if c.config.ListenerEnabled {
wg.Add(1)
go func() {
defer wg.Done()
c.log.WithField("address", c.server.Addr).Info("Serving health checks")
if err := c.server.ListenAndServe(); !errors.Is(err, http.ErrServerClosed) {
c.log.WithError(err).Warn("Error serving health checks")
}
}()
}
wg.Add(1)
go func() {
defer wg.Done()
<-ctx.Done()
if c.server != nil {
_ = c.server.Close()
}
}()
wg.Wait()
return nil
}
// WaitForTestDial tries to create a client connection to the given target
// with a blocking dial and a timeout specified in testDialTimeout.
// Nothing is done with the connection, which is just closed in case it
// is created.
func WaitForTestDial(ctx context.Context, addr net.Addr) {
ctx, cancel := context.WithTimeout(ctx, testDialTimeout)
defer cancel()
conn, err := grpc.DialContext(ctx,
addr.String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithContextDialer(func(ctx context.Context, name string) (net.Conn, error) {
return net.DialUnix("unix", nil, &net.UnixAddr{
Net: "unix",
Name: name,
})
}),
grpc.WithBlock())
if err != nil {
return
}
_ = conn.Close()
}
// LiveState returns the global live state and details.
func (c *checker) LiveState() (bool, interface{}) {
live, _, details, _ := c.checkStates()
return live, details
}
// ReadyState returns the global ready state and details.
func (c *checker) ReadyState() (bool, interface{}) {
_, ready, _, details := c.checkStates()
return ready, details
}
func (c *checker) checkStates() (bool, bool, interface{}, interface{}) {
isLive, isReady := true, true
liveDetails := make(map[string]interface{})
readyDetails := make(map[string]interface{})
for subsystemName, subsystemState := range c.cache.getStatuses() {
state := subsystemState.details
if !state.Live {
isLive = false
}
if !state.Ready {
isReady = false
}
liveDetails[subsystemName] = state.LiveDetails
readyDetails[subsystemName] = state.ReadyDetails
}
return isLive, isReady, liveDetails, readyDetails
}
func (c *checker) liveHandler(w http.ResponseWriter, req *http.Request) {
live, details := c.LiveState()
statusCode := http.StatusOK
if !live {
statusCode = http.StatusInternalServerError
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(statusCode)
_ = json.NewEncoder(w).Encode(details)
}
func (c *checker) readyHandler(w http.ResponseWriter, req *http.Request) {
ready, details := c.ReadyState()
statusCode := http.StatusOK
if !ready {
statusCode = http.StatusInternalServerError
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(statusCode)
_ = json.NewEncoder(w).Encode(details)
}