-
Notifications
You must be signed in to change notification settings - Fork 42
/
health_controller.go
286 lines (245 loc) · 6.56 KB
/
health_controller.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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
package web
import (
"bytes"
"fmt"
"io"
"net/http"
"slices"
"strings"
"github.com/gin-gonic/gin"
"golang.org/x/exp/maps"
"github.com/smartcontractkit/chainlink/v2/core/services/chainlink"
"github.com/smartcontractkit/chainlink/v2/core/web/presenters"
)
type HealthController struct {
App chainlink.Application
}
const (
HealthStatusPassing = "passing"
HealthStatusFailing = "failing"
)
// NOTE: We only implement the k8s readiness check, *not* the liveness check. Liveness checks are only recommended in cases
// where the app doesn't crash itself on panic, and if implemented incorrectly can cause cascading failures.
// See the following for more information:
// - https://srcco.de/posts/kubernetes-liveness-probes-are-dangerous.html
func (hc *HealthController) Readyz(c *gin.Context) {
status := http.StatusOK
checker := hc.App.GetHealthChecker()
ready, errors := checker.IsReady()
if !ready {
status = http.StatusServiceUnavailable
}
c.Status(status)
if _, ok := c.GetQuery("full"); !ok {
return
}
checks := make([]presenters.Check, 0, len(errors))
for name, err := range errors {
status := HealthStatusPassing
var output string
if err != nil {
status = HealthStatusFailing
output = err.Error()
}
checks = append(checks, presenters.Check{
JAID: presenters.NewJAID(name),
Name: name,
Status: status,
Output: output,
})
}
// return a json description of all the checks
jsonAPIResponse(c, checks, "checks")
}
func (hc *HealthController) Health(c *gin.Context) {
status := http.StatusOK
checker := hc.App.GetHealthChecker()
healthy, errors := checker.IsHealthy()
if !healthy {
status = http.StatusMultiStatus
}
c.Status(status)
checks := make([]presenters.Check, 0, len(errors))
for name, err := range errors {
status := HealthStatusPassing
var output string
if err != nil {
status = HealthStatusFailing
output = err.Error()
}
checks = append(checks, presenters.Check{
JAID: presenters.NewJAID(name),
Name: name,
Status: status,
Output: output,
})
}
switch c.NegotiateFormat(gin.MIMEJSON, gin.MIMEHTML, gin.MIMEPlain) {
case gin.MIMEJSON:
break // default
case gin.MIMEHTML:
if err := newCheckTree(checks).WriteHTMLTo(c.Writer); err != nil {
hc.App.GetLogger().Errorw("Failed to write HTML health report", "err", err)
c.AbortWithStatus(http.StatusInternalServerError)
}
return
case gin.MIMEPlain:
if err := writeTextTo(c.Writer, checks); err != nil {
hc.App.GetLogger().Errorw("Failed to write plaintext health report", "err", err)
c.AbortWithStatus(http.StatusInternalServerError)
}
return
}
slices.SortFunc(checks, presenters.CmpCheckName)
jsonAPIResponseWithStatus(c, checks, "checks", status)
}
func writeTextTo(w io.Writer, checks []presenters.Check) error {
slices.SortFunc(checks, presenters.CmpCheckName)
for _, ch := range checks {
status := "?"
switch ch.Status {
case HealthStatusPassing:
status = "-"
case HealthStatusFailing:
status = "!"
}
if _, err := fmt.Fprintf(w, "%s%s\n", status, ch.Name); err != nil {
return err
}
if ch.Output != "" {
if _, err := fmt.Fprintf(newLinePrefixWriter(w, "\t"), "\t%s", ch.Output); err != nil {
return err
}
if _, err := fmt.Fprintln(w); err != nil {
return err
}
}
}
return nil
}
type checkNode struct {
Name string // full
Status string
Output string
Subs checkTree
}
type checkTree map[string]checkNode
func newCheckTree(checks []presenters.Check) checkTree {
slices.SortFunc(checks, presenters.CmpCheckName)
root := make(checkTree)
for _, c := range checks {
parts := strings.Split(c.Name, ".")
node := root
for _, short := range parts[:len(parts)-1] {
n, ok := node[short]
if !ok {
n = checkNode{Subs: make(checkTree)}
node[short] = n
}
node = n.Subs
}
p := parts[len(parts)-1]
node[p] = checkNode{
Name: c.Name,
Status: c.Status,
Output: c.Output,
Subs: make(checkTree),
}
}
return root
}
func (t checkTree) WriteHTMLTo(w io.Writer) error {
if _, err := io.WriteString(w, `<style>
details {
margin: 0.0em 0.0em 0.0em 0.4em;
padding: 0.3em 0.0em 0.0em 0.4em;
}
pre {
margin-left:1em;
margin-top: 0;
}
summary {
padding-bottom: 0.4em;
}
details {
border: thin solid black;
border-bottom-color: rgba(0,0,0,0);
border-right-color: rgba(0,0,0,0);
}
.passing:after {
color: blue;
content: " - (Passing)";
font-size:small;
text-transform: uppercase;
}
.failing:after {
color: red;
content: " - (Failing)";
font-weight: bold;
font-size:small;
text-transform: uppercase;
}
summary.noexpand::marker {
color: rgba(100,101,10,0);
}
</style>`); err != nil {
return err
}
return t.writeHTMLTo(newLinePrefixWriter(w, ""))
}
func (t checkTree) writeHTMLTo(w *linePrefixWriter) error {
keys := maps.Keys(t)
slices.Sort(keys)
for _, short := range keys {
node := t[short]
if _, err := io.WriteString(w, `
<details open>`); err != nil {
return err
}
var expand string
if node.Output == "" && len(node.Subs) == 0 {
expand = ` class="noexpand"`
}
if _, err := fmt.Fprintf(w, `
<summary title="%s"%s><span class="%s">%s</span></summary>`, node.Name, expand, node.Status, short); err != nil {
return err
}
if node.Output != "" {
if _, err := w.WriteRawLinef(" <pre>%s</pre>", node.Output); err != nil {
return err
}
}
if len(node.Subs) > 0 {
if err := node.Subs.writeHTMLTo(w.new(" ")); err != nil {
return err
}
}
if _, err := io.WriteString(w, "\n</details>"); err != nil {
return err
}
}
return nil
}
type linePrefixWriter struct {
w io.Writer
prefix string
prefixB []byte
}
func newLinePrefixWriter(w io.Writer, prefix string) *linePrefixWriter {
prefix = "\n" + prefix
return &linePrefixWriter{w: w, prefix: prefix, prefixB: []byte(prefix)}
}
func (w *linePrefixWriter) new(prefix string) *linePrefixWriter {
prefix = w.prefix + prefix
return &linePrefixWriter{w: w.w, prefix: prefix, prefixB: []byte(prefix)}
}
func (w *linePrefixWriter) Write(b []byte) (int, error) {
return w.w.Write(bytes.ReplaceAll(b, []byte("\n"), w.prefixB))
}
func (w *linePrefixWriter) WriteString(s string) (n int, err error) {
return io.WriteString(w.w, strings.ReplaceAll(s, "\n", w.prefix))
}
// WriteRawLinef writes a new newline with prefix, followed by s without modification.
func (w *linePrefixWriter) WriteRawLinef(s string, args ...any) (n int, err error) {
return fmt.Fprintf(w.w, w.prefix+s, args...)
}