-
Notifications
You must be signed in to change notification settings - Fork 4.2k
/
output.go
393 lines (359 loc) · 9.04 KB
/
output.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
package diagnose
import (
"context"
"errors"
"fmt"
"io"
"sort"
"strings"
"sync"
"time"
"go.opentelemetry.io/otel/attribute"
wordwrap "github.com/mitchellh/go-wordwrap"
"go.opentelemetry.io/otel/codes"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/trace"
)
const (
status_unknown = "[ ] "
status_ok = "\u001b[32m[ success ]\u001b[0m "
status_failed = "\u001b[31m[ failure ]\u001b[0m "
status_warn = "\u001b[33m[ warning ]\u001b[0m "
status_skipped = "\u001b[90m[ skipped ]\u001b[0m "
same_line = "\x0d"
ErrorStatus = 2
WarningStatus = 1
OkStatus = 0
SkippedStatus = -1
)
var errUnimplemented = errors.New("unimplemented")
type status int
func (s status) String() string {
switch s {
case OkStatus:
return "ok"
case WarningStatus:
return "warn"
case ErrorStatus:
return "fail"
}
return "invalid"
}
func (s status) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprint("\"", s.String(), "\"")), nil
}
type Result struct {
Time time.Time `json:"time"`
Name string `json:"name"`
Status status `json:"status"`
Warnings []string `json:"warnings,omitempty"`
Message string `json:"message,omitempty"`
Advice string
Children []*Result `json:"children,omitempty"`
}
func (r *Result) finalize() status {
maxStatus := r.Status
if len(r.Children) > 0 {
sort.SliceStable(r.Children, func(i, j int) bool {
return r.Children[i].Time.Before(r.Children[j].Time)
})
for _, c := range r.Children {
cms := c.finalize()
if cms > maxStatus {
maxStatus = cms
}
}
if maxStatus > r.Status {
r.Status = maxStatus
}
}
return maxStatus
}
func (r *Result) ZeroTimes() {
var zero time.Time
r.Time = zero
for _, c := range r.Children {
c.ZeroTimes()
}
}
// TelemetryCollector is an otel SpanProcessor that gathers spans and once the outermost
// span ends, walks the otel traces in order to produce a top-down tree of Diagnose results.
type TelemetryCollector struct {
ui io.Writer
spans map[trace.SpanID]sdktrace.ReadOnlySpan
rootSpan sdktrace.ReadOnlySpan
results map[trace.SpanID]*Result
RootResult *Result
mu sync.Mutex
}
// NewTelemetryCollector creates a SpanProcessor that collects OpenTelemetry spans
// and aggregates them into a tree structure for use by Diagnose.
// It also outputs the status of main sections to that writer.
func NewTelemetryCollector(w io.Writer) *TelemetryCollector {
return &TelemetryCollector{
ui: w,
spans: make(map[trace.SpanID]sdktrace.ReadOnlySpan),
results: make(map[trace.SpanID]*Result),
}
}
// OnStart tracks spans by id for later retrieval
func (t *TelemetryCollector) OnStart(_ context.Context, s sdktrace.ReadWriteSpan) {
t.mu.Lock()
defer t.mu.Unlock()
t.spans[s.SpanContext().SpanID()] = s
if isMainSection(s) {
fmt.Fprintf(t.ui, status_unknown+s.Name())
}
}
func isMainSection(s sdktrace.ReadOnlySpan) bool {
for _, a := range s.Attributes() {
if a.Key == "diagnose" && a.Value.AsString() == "main-section" {
return true
}
}
return false
}
func (t *TelemetryCollector) OnEnd(e sdktrace.ReadOnlySpan) {
t.mu.Lock()
defer t.mu.Unlock()
if !e.Parent().HasSpanID() {
// First walk the span structs to construct the top down tree results we want
for _, s := range t.spans {
r := t.getOrBuildResult(s.SpanContext().SpanID())
if r != nil {
if s.Parent().HasSpanID() {
p := t.getOrBuildResult(s.Parent().SpanID())
if p != nil {
p.Children = append(p.Children, r)
}
} else {
t.RootResult = r
}
}
}
// Then walk the results sorting children by time
t.RootResult.finalize()
} else if isMainSection(e) {
r := t.getOrBuildResult(e.SpanContext().SpanID())
if r != nil {
fmt.Print(same_line)
fmt.Fprintln(t.ui, r.String())
}
}
}
// required to implement SpanProcessor, but noops for our purposes
func (t *TelemetryCollector) Shutdown(_ context.Context) error {
return nil
}
// required to implement SpanProcessor, but noops for our purposes
func (t *TelemetryCollector) ForceFlush(_ context.Context) error {
return nil
}
func (t *TelemetryCollector) getOrBuildResult(id trace.SpanID) *Result {
s := t.spans[id]
if s == nil {
return nil
}
r, ok := t.results[id]
if !ok {
r = &Result{
Name: s.Name(),
Message: s.StatusMessage(),
Time: s.StartTime(),
}
for _, e := range s.Events() {
switch e.Name {
case warningEventName:
for _, a := range e.Attributes {
if a.Key == messageKey {
r.Warnings = append(r.Warnings, a.Value.AsString())
}
}
case skippedEventName:
r.Status = SkippedStatus
case "fail":
message, action := findAttributes(e, errorMessageKey, actionKey)
if message != "" && action != "" {
r.Children = append(r.Children, &Result{
Name: action,
Status: ErrorStatus,
Message: message,
})
}
case spotCheckOkEventName:
checkName, message := findAttributes(e, nameKey, messageKey)
if checkName != "" {
r.Children = append(r.Children,
&Result{
Name: checkName,
Status: OkStatus,
Message: message,
Time: e.Time,
Advice: findAttribute(e, adviceKey),
})
}
case spotCheckWarnEventName:
checkName, message := findAttributes(e, nameKey, messageKey)
if checkName != "" {
r.Children = append(r.Children,
&Result{
Name: checkName,
Status: WarningStatus,
Message: message,
Time: e.Time,
Advice: findAttribute(e, adviceKey),
})
}
case spotCheckErrorEventName:
checkName, message := findAttributes(e, nameKey, messageKey)
if checkName != "" {
r.Children = append(r.Children,
&Result{
Name: checkName,
Status: ErrorStatus,
Message: message,
Time: e.Time,
Advice: findAttribute(e, adviceKey),
})
}
case spotCheckSkippedEventName:
checkName, message := findAttributes(e, nameKey, messageKey)
if checkName != "" {
r.Children = append(r.Children,
&Result{
Name: checkName,
Status: SkippedStatus,
Message: message,
Time: e.Time,
Advice: findAttribute(e, adviceKey),
})
}
case adviceEventName:
message, _ := findAttributes(e, adviceKey, "")
if message != "" {
r.Advice = message
}
}
}
switch s.StatusCode() {
case codes.Unset:
if len(r.Warnings) > 0 {
r.Status = WarningStatus
} else if r.Status != SkippedStatus {
r.Status = OkStatus
}
case codes.Ok:
if r.Status != SkippedStatus {
r.Status = OkStatus
}
case codes.Error:
if r.Status != SkippedStatus {
r.Status = ErrorStatus
}
}
t.results[id] = r
}
return r
}
func findAttribute(e trace.Event, attr attribute.Key) string {
for _, a := range e.Attributes {
if a.Key == attr {
return a.Value.AsString()
}
}
return ""
}
func findAttributes(e trace.Event, attr1, attr2 attribute.Key) (string, string) {
var av1, av2 string
for _, a := range e.Attributes {
switch a.Key {
case attr1:
av1 = a.Value.AsString()
case attr2:
av2 = a.Value.AsString()
}
}
return av1, av2
}
// Write outputs a human readable version of the results tree
func (r *Result) Write(writer io.Writer, wrapLimit int) error {
var sb strings.Builder
r.write(&sb, 0, wrapLimit)
_, err := writer.Write([]byte(sb.String()))
return err
}
const (
indentString = " "
statusPrefixLen = 9
)
func indent(sb *strings.Builder, depth int) {
for i := 0; i < depth; i++ {
sb.WriteString(indentString)
}
}
func (r *Result) String() string {
return r.StringWrapped(80)
}
func (r *Result) StringWrapped(wrapLimit int) string {
var sb strings.Builder
r.write(&sb, 0, wrapLimit)
return sb.String()
}
func (r *Result) write(sb *strings.Builder, depth int, limit int) {
indent(sb, depth)
var prelude string
switch r.Status {
case OkStatus:
prelude = status_ok
case WarningStatus:
prelude = status_warn
case ErrorStatus:
prelude = status_failed
case SkippedStatus:
prelude = status_skipped
}
prelude = prelude + r.Name
if r.Message != "" {
prelude = prelude + ": " + r.Message
}
warnings := r.Warnings
if r.Message == "" && len(warnings) > 0 {
prelude = status_warn + r.Name + ": "
if len(warnings) == 1 {
prelude = prelude + warnings[0]
warnings = warnings[1:]
}
}
writeWrapped(sb, prelude, depth+1, limit)
for _, w := range warnings {
sb.WriteRune('\n')
indent(sb, depth+1)
sb.WriteString(status_warn)
writeWrapped(sb, w, depth+2, limit)
}
if r.Advice != "" {
advice := "\u001b[35m" + r.Advice + "\u001b[0m"
sb.WriteRune('\n')
indent(sb, depth+1)
writeWrapped(sb, advice, depth+1, limit)
}
sb.WriteRune('\n')
for _, c := range r.Children {
c.write(sb, depth+1, limit)
}
}
func writeWrapped(sb *strings.Builder, msg string, depth int, limit int) {
if limit > 0 {
sz := uint(limit - depth*len(indentString))
msg = wordwrap.WrapString(msg, sz)
parts := strings.Split(msg, "\n")
sb.WriteString(parts[0])
for _, p := range parts[1:] {
sb.WriteRune('\n')
indent(sb, depth)
sb.WriteString(p)
}
} else {
sb.WriteString(msg)
}
}