forked from sourcegraph/checkup
-
Notifications
You must be signed in to change notification settings - Fork 0
/
checkup.go
666 lines (594 loc) · 17.7 KB
/
checkup.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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
// Package checkup provides means for checking and reporting the
// status and performance of various endpoints in a distributed,
// lock-free, self-hosted fashion.
package checkup
import (
"bytes"
"encoding/json"
"fmt"
"log"
"sort"
"strings"
"sync"
"time"
"github.com/fatih/color"
)
// Checkup performs a routine checkup on endpoints or
// services.
type Checkup struct {
// Checkers is the list of Checkers to use with
// which to perform checks.
Checkers []Checker `json:"checkers,omitempty"`
// ConcurrentChecks is how many checks, at most, to
// perform concurrently. Default is
// DefaultConcurrentChecks.
ConcurrentChecks int `json:"concurrent_checks,omitempty"`
// Timestamp is the timestamp to force for all checks.
// Useful if wanting to perform distributed check
// "at the same time" even if they might actually
// be a few milliseconds or seconds apart.
Timestamp time.Time `json:"timestamp,omitempty"`
// Storage is the storage mechanism for saving the
// results of checks. Required if calling Store().
// If Storage is also a Maintainer, its Maintain()
// method will be called by c.CheckAndStore().
Storage Storage `json:"storage,omitempty"`
// Notifier is a notifier that will be passed the
// results after checks from all checkers have
// completed. Notifier may evaluate and choose to
// send a notification of potential problems.
Notifier Notifier `json:"notifier,omitempty"`
}
// Check performs the health checks. An error is only
// returned in the case of a misconfiguration or if
// any one of the Checkers returns an error.
func (c Checkup) Check() ([]Result, error) {
if c.ConcurrentChecks == 0 {
c.ConcurrentChecks = DefaultConcurrentChecks
}
if c.ConcurrentChecks < 0 {
return nil, fmt.Errorf("invalid value for ConcurrentChecks: %d (must be set > 0)",
c.ConcurrentChecks)
}
results := make([]Result, len(c.Checkers))
errs := make(Errors, len(c.Checkers))
throttle := make(chan struct{}, c.ConcurrentChecks)
wg := sync.WaitGroup{}
for i, checker := range c.Checkers {
throttle <- struct{}{}
wg.Add(1)
go func(i int, checker Checker) {
results[i], errs[i] = checker.Check()
<-throttle
wg.Done()
}(i, checker)
}
wg.Wait()
if !c.Timestamp.IsZero() {
for i := range results {
results[i].Timestamp = c.Timestamp.UTC().UnixNano()
}
}
if !errs.Empty() {
return results, errs
}
if c.Notifier != nil {
err := c.Notifier.Notify(results)
if err != nil {
return results, err
}
}
return results, nil
}
// CheckAndStore performs health checks and immediately
// stores the results to the configured storage if there
// were no errors. Checks are not performed if c.Storage
// is nil. If c.Storage is also a Maintainer, Maintain()
// will be called if Store() is successful.
func (c Checkup) CheckAndStore() error {
if c.Storage == nil {
return fmt.Errorf("no storage mechanism defined")
}
results, err := c.Check()
if err != nil {
return err
}
err = c.Storage.Store(results)
if err != nil {
return err
}
if m, ok := c.Storage.(Maintainer); ok {
return m.Maintain()
}
return nil
}
// CheckAndStoreEvery calls CheckAndStore every interval. It returns
// the ticker that it's using so you can stop it when you don't want
// it to run anymore. This function does NOT block (it runs the ticker
// in a goroutine). Any errors are written to the standard logger. It
// would not be wise to set an interval lower than the time it takes
// to perform the checks.
func (c Checkup) CheckAndStoreEvery(interval time.Duration) *time.Ticker {
ticker := time.NewTicker(interval)
go func() {
for range ticker.C {
if err := c.CheckAndStore(); err != nil {
log.Println(err)
}
}
}()
return ticker
}
// MarshalJSON marshals c into JSON with type information
// included on the interface values.
func (c Checkup) MarshalJSON() ([]byte, error) {
// Start with the fields of c that don't require special
// handling; unfortunately this has to mimic c's definition.
easy := struct {
ConcurrentChecks int `json:"concurrent_checks,omitempty"`
Timestamp time.Time `json:"timestamp,omitempty"`
}{
ConcurrentChecks: c.ConcurrentChecks,
Timestamp: c.Timestamp,
}
result, err := json.Marshal(easy)
if err != nil {
return result, err
}
wrap := func(key string, value []byte) {
b := append([]byte{result[0]}, []byte(`"`+key+`":`)...)
b = append(b, value...)
if len(result) > 2 {
b = append(b, ',')
}
result = append(b, result[1:]...)
}
// Checkers
if len(c.Checkers) > 0 {
var checkers [][]byte
for _, ch := range c.Checkers {
chb, err := json.Marshal(ch)
if err != nil {
return result, err
}
var typeName string
switch ch.(type) {
case HTTPChecker:
typeName = "http"
case TCPChecker:
typeName = "tcp"
case DNSChecker:
typeName = "dns"
case TLSChecker:
typeName = "tls"
default:
return result, fmt.Errorf("unknown Checker type")
}
chb = []byte(fmt.Sprintf(`{"type":"%s",%s`, typeName, string(chb[1:])))
checkers = append(checkers, chb)
}
allCheckers := []byte{'['}
allCheckers = append([]byte{'['}, bytes.Join(checkers, []byte(","))...)
allCheckers = append(allCheckers, ']')
wrap("checkers", allCheckers)
}
// Storage
if c.Storage != nil {
sb, err := json.Marshal(c.Storage)
if err != nil {
return result, err
}
var providerName string
switch c.Storage.(type) {
case *GitHub:
providerName = "github"
case S3:
providerName = "s3"
case FS:
providerName = "fs"
case SQL:
providerName = "sql"
default:
return result, fmt.Errorf("unknown Storage type: %T", c.Storage)
}
sb = []byte(fmt.Sprintf(`{"provider":"%s",%s`, providerName, string(sb[1:])))
wrap("storage", sb)
}
// Notifier
if c.Notifier != nil {
nb, err := json.Marshal(c.Notifier)
if err != nil {
return result, err
}
var notifierName string
switch c.Notifier.(type) {
case Slack:
notifierName = "slack"
default:
return result, fmt.Errorf("unknown Notifier type")
}
nb = []byte(fmt.Sprintf(`{"name":"%s",%s`, notifierName, string(nb[1:])))
wrap("notifier", nb)
}
return result, nil
}
// UnmarshalJSON unmarshales b into c. To succeed, it
// requires type information for the interface values.
func (c *Checkup) UnmarshalJSON(b []byte) error {
// Unmarshal as much of b as we can; this requires
// a type that doesn't implement json.Unmarshaler,
// hence the conversion. We also know that the
// interface types will ultimately cause an error,
// but we can ignore it because we handle it below.
type checkup2 *Checkup
json.Unmarshal(b, checkup2(c))
c.Checkers = []Checker{} // clean the slate
// Begin unmarshaling interface values by
// collecting the raw JSON
raw := struct {
Checkers []json.RawMessage `json:"checkers"`
Storage json.RawMessage `json:"storage"`
Notifier json.RawMessage `json:"notifier"`
}{}
err := json.Unmarshal([]byte(b), &raw)
if err != nil {
return err
}
// Then collect the concrete type information
types := struct {
Checkers []struct {
Type string `json:"type"`
}
Storage struct {
Provider string `json:"provider"`
}
Notifier struct {
Name string `json:"name"`
Username string `json:"username"`
Channel string `json:"channel"`
Webhook string `json:"webhook"`
}
}{}
err = json.Unmarshal([]byte(b), &types)
if err != nil {
return err
}
// Finally, we unmarshal the remaining values using type
// assertions with the help of the type information
for i, t := range types.Checkers {
switch t.Type {
case "http":
var checker HTTPChecker
err = json.Unmarshal(raw.Checkers[i], &checker)
if err != nil {
return err
}
c.Checkers = append(c.Checkers, checker)
case "tcp":
var checker TCPChecker
err = json.Unmarshal(raw.Checkers[i], &checker)
if err != nil {
return err
}
c.Checkers = append(c.Checkers, checker)
case "dns":
var checker DNSChecker
err = json.Unmarshal(raw.Checkers[i], &checker)
if err != nil {
return err
}
c.Checkers = append(c.Checkers, checker)
case "tls":
var checker TLSChecker
err = json.Unmarshal(raw.Checkers[i], &checker)
if err != nil {
return err
}
c.Checkers = append(c.Checkers, checker)
default:
return fmt.Errorf("%s: unknown Checker type", t.Type)
}
}
if raw.Storage != nil {
switch types.Storage.Provider {
case "s3":
var storage S3
err = json.Unmarshal(raw.Storage, &storage)
if err != nil {
return err
}
c.Storage = storage
case "fs":
var storage FS
err = json.Unmarshal(raw.Storage, &storage)
if err != nil {
return err
}
c.Storage = storage
case "github":
storage := &GitHub{}
err = json.Unmarshal(raw.Storage, storage)
if err != nil {
return err
}
c.Storage = storage
case "sql":
var storage SQL
err = json.Unmarshal(raw.Storage, &storage)
if err != nil {
return err
}
c.Storage = storage
default:
return fmt.Errorf("%s: unknown Storage type", types.Storage.Provider)
}
}
if raw.Notifier != nil {
switch types.Notifier.Name {
case "slack":
var notifier Slack
err = json.Unmarshal(raw.Notifier, ¬ifier)
if err != nil {
return err
}
c.Notifier = notifier
default:
return fmt.Errorf("%s: unknown Notifier type", types.Notifier.Name)
}
}
return nil
}
// Checker can create a Result.
type Checker interface {
Check() (Result, error)
}
// Storage can store results.
type Storage interface {
Store([]Result) error
}
// StorageReader can read results from the Storage.
type StorageReader interface {
// Fetch returns the contents of a check file.
Fetch(checkFile string) ([]Result, error)
// GetIndex returns the storage index, as a map where keys are check
// result filenames and values are the associated check timestamps.
GetIndex() (map[string]int64, error)
}
// Maintainer can maintain a store of results by
// deleting old check files that are no longer
// needed or performing other required tasks.
type Maintainer interface {
Maintain() error
}
// Notifier can notify ops or sysadmins of
// potential problems. A Notifier should keep
// state to avoid sending repeated notices
// more often than the admin would like.
type Notifier interface {
Notify([]Result) error
}
// DefaultConcurrentChecks is how many checks,
// at most, to perform concurrently.
var DefaultConcurrentChecks = 5
// FilenameFormatString is the format string used
// by GenerateFilename to create a filename.
const FilenameFormatString = "%d-check.json"
// Timestamp returns the UTC Unix timestamp in
// nanoseconds.
func Timestamp() int64 {
return time.Now().UTC().UnixNano()
}
// GenerateFilename returns a filename that is ideal
// for storing the results file on a storage provider
// that relies on the filename for retrieval that is
// sorted by date/timeframe. It returns a string pointer
// to be used by the AWS SDK...
func GenerateFilename() *string {
s := fmt.Sprintf(FilenameFormatString, Timestamp())
return &s
}
// Result is the result of a health check.
type Result struct {
// Title is the title (or name) of the thing that was checked.
// It should be unique, as it acts like an identifier to users.
Title string `json:"title,omitempty"`
// Endpoint is the URL/address/path/identifier/locator/whatever
// of what was checked.
Endpoint string `json:"endpoint,omitempty"`
// Timestamp is when the check occurred; UTC UnixNano format.
Timestamp int64 `json:"timestamp,omitempty"`
// Times is a list of each individual check attempt.
Times Attempts `json:"times,omitempty"`
// ThresholdRTT is the maximum RTT that was tolerated before
// considering performance to be degraded. Leave 0 if irrelevant.
ThresholdRTT time.Duration `json:"threshold,omitempty"`
// Healthy, Degraded, and Down contain the ultimate conclusion
// about the endpoint. Exactly one of these should be true;
// any more or less is a bug.
Healthy bool `json:"healthy,omitempty"`
Degraded bool `json:"degraded,omitempty"`
Down bool `json:"down,omitempty"`
// Notice contains a description of some condition of this
// check that might have affected the result in some way.
// For example, that the median RTT is above the threshold.
Notice string `json:"notice,omitempty"`
// Message is an optional message to show on the status page.
// For example, what you're doing to fix a problem.
Message string `json:"message,omitempty"`
}
// ComputeStats computes basic statistics about r.
func (r Result) ComputeStats() Stats {
var s Stats
for _, a := range r.Times {
s.Total += a.RTT
if a.RTT < s.Min || s.Min == 0 {
s.Min = a.RTT
}
if a.RTT > s.Max || s.Max == 0 {
s.Max = a.RTT
}
}
sorted := make(Attempts, len(r.Times))
copy(sorted, r.Times)
sort.Sort(sorted)
half := len(sorted) / 2
if len(sorted)%2 == 0 {
s.Median = (sorted[half-1].RTT + sorted[half].RTT) / 2
} else {
s.Median = sorted[half].RTT
}
s.Mean = time.Duration(int64(s.Total) / int64(len(r.Times)))
return s
}
// String returns a human-readable rendering of r.
func (r Result) String() string {
stats := r.ComputeStats()
s := fmt.Sprintf("== %s - %s\n", r.Title, r.Endpoint)
s += fmt.Sprintf(" Threshold: %s\n", r.ThresholdRTT)
s += fmt.Sprintf(" Max: %s\n", stats.Max)
s += fmt.Sprintf(" Min: %s\n", stats.Min)
s += fmt.Sprintf(" Median: %s\n", stats.Median)
s += fmt.Sprintf(" Mean: %s\n", stats.Mean)
s += fmt.Sprintf(" All: %v\n", r.Times)
statusLine := fmt.Sprintf(" Assessment: %v\n", r.Status())
switch r.Status() {
case Healthy:
statusLine = color.GreenString(statusLine)
case Degraded:
statusLine = color.YellowString(statusLine)
case Down:
statusLine = color.RedString(statusLine)
}
s += statusLine
return s
}
// Status returns a text representation of the overall status
// indicated in r.
func (r Result) Status() StatusText {
if r.Down {
return Down
} else if r.Degraded {
return Degraded
} else if r.Healthy {
return Healthy
}
return Unknown
}
// DisableColor disables ANSI colors in the Result default string.
func DisableColor() {
color.NoColor = true
}
// StatusText is the textual representation of the
// result of a status check.
type StatusText string
// PriorityOver returns whether s has priority over other.
// For example, a Down status has priority over Degraded.
func (s StatusText) PriorityOver(other StatusText) bool {
if s == other {
return false
}
switch s {
case Down:
return true
case Degraded:
if other == Down {
return false
}
return true
case Healthy:
if other == Unknown {
return true
}
return false
}
return false
}
// Text representations for the status of a check.
const (
Healthy StatusText = "healthy"
Degraded StatusText = "degraded"
Down StatusText = "down"
Unknown StatusText = "unknown"
)
// Attempt is an attempt to communicate with the endpoint.
type Attempt struct {
RTT time.Duration `json:"rtt"`
Error string `json:"error,omitempty"`
}
// Attempts is a list of Attempt that can be sorted by RTT.
type Attempts []Attempt
func (a Attempts) Len() int { return len(a) }
func (a Attempts) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a Attempts) Less(i, j int) bool { return a[i].RTT < a[j].RTT }
// Stats is a type that holds information about a Result,
// especially its various Attempts.
type Stats struct {
Total time.Duration `json:"total,omitempty"`
Mean time.Duration `json:"mean,omitempty"`
Median time.Duration `json:"median,omitempty"`
Min time.Duration `json:"min,omitempty"`
Max time.Duration `json:"max,omitempty"`
}
// Errors is an error type that concatenates multiple errors.
type Errors []error
// Error returns a string containing all the errors in e.
func (e Errors) Error() string {
var errs []string
for _, err := range e {
if err != nil {
errs = append(errs, err.Error())
}
}
return strings.Join(errs, "; ")
}
// Empty returns whether e has any non-nil errors in it.
func (e Errors) Empty() bool {
for _, err := range e {
if err != nil {
return false
}
}
return true
}
// Provisioner is a type of storage mechanism that can
// provision itself for use with checkup. Provisioning
// need only happen once and is merely a convenience
// so that the user can get up and running with their
// status page more quickly. Presumably, the info
// returned from Provision should be used on the status
// page side of things ot access the check files (like
// a key pair that is used for read-only access).
type Provisioner interface {
Provision() (ProvisionInfo, error)
}
// ProvisionInfo contains the results of provisioning a new
// storage facility for check files. Its values should be
// used by the status page in order to obtain read-only
// access to the check files.
type ProvisionInfo struct {
// The ID of a user that was created for accessing checks.
UserID string `json:"user_id"`
// The username of a user that was created for accessing checks.
Username string `json:"username"`
// The ID or name of the ID/key used to access checks. Expect
// this value to be made public. (It should have read-only
// access to the checks.)
PublicAccessKeyID string `json:"public_access_key_id"`
// The "secret" associated with the PublicAccessKeyID, but
// expect this value to be made public. (It should provide
// read-only access to the checks.)
PublicAccessKey string `json:"public_access_key"`
}
// String returns the information in i in a human-readable format
// along with an important notice.
func (i ProvisionInfo) String() string {
s := "Provision successful\n\n"
s += fmt.Sprintf(" User ID: %s\n", i.UserID)
s += fmt.Sprintf(" Username: %s\n", i.Username)
s += fmt.Sprintf("Public Access Key ID: %s\n", i.PublicAccessKeyID)
s += fmt.Sprintf(" Public Access Key: %s\n\n", i.PublicAccessKey)
s += `IMPORTANT: Copy the Public Access Key ID and Public Access
Key into the config.js file for your status page. You will
not be shown these credentials again.`
return s
}