-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
formatter.go
430 lines (377 loc) · 9.72 KB
/
formatter.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
/*
Copyright 2021 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package config
import (
"bytes"
"fmt"
"reflect"
"regexp"
"runtime"
"sort"
"strconv"
"strings"
"time"
"github.com/gravitational/teleport/api/utils"
"github.com/gravitational/trace"
log "github.com/sirupsen/logrus"
)
type textFormatter struct {
// ComponentPadding is a padding to pick when displaying
// and formatting component field, defaults to DefaultComponentPadding
ComponentPadding int
// EnableColors enables colored output
EnableColors bool
// FormatCaller is a function to return (part) of source file path for output.
// Defaults to filePathAndLine() if unspecified
FormatCaller func() (caller string)
// ExtraFields represent the extra fields that will be added to the log message
ExtraFields []string
// TimestampEnabled specifies if timestamp is enabled in logs
timestampEnabled bool
// CallerEnabled specifies if caller is enabled in logs
callerEnabled bool
}
type writer struct {
bytes.Buffer
}
const (
noColor = -1
red = 31
yellow = 33
blue = 36
gray = 37
levelField = "level"
componentField = "component"
callerField = "caller"
timestampField = "timestamp"
messageField = "message"
)
// CheckAndSetDefaults checks and sets log format configuration
func (tf *textFormatter) CheckAndSetDefaults() error {
// set padding
if tf.ComponentPadding == 0 {
tf.ComponentPadding = trace.DefaultComponentPadding
}
// set caller
tf.FormatCaller = formatCallerWithPathAndLine
// set log formatting
if tf.ExtraFields == nil {
tf.timestampEnabled = true
tf.callerEnabled = true
tf.ExtraFields = KnownFormatFields.names()
return nil
}
// parse input
res, err := parseInputFormat(tf.ExtraFields)
if err != nil {
return trace.Wrap(err)
}
if utils.SliceContainsStr(res, timestampField) {
tf.timestampEnabled = true
}
if utils.SliceContainsStr(res, callerField) {
tf.callerEnabled = true
}
tf.ExtraFields = res
return nil
}
// Format formats each log line as confiured in teleport config file
func (tf *textFormatter) Format(e *log.Entry) ([]byte, error) {
var data []byte
caller := tf.FormatCaller()
w := &writer{}
// write timestamp first if enabled
if tf.timestampEnabled {
w.writeField(e.Time.Format(time.RFC3339), noColor)
}
for _, match := range tf.ExtraFields {
switch match {
case "level":
color := noColor
if tf.EnableColors {
switch e.Level {
case log.DebugLevel:
color = gray
case log.WarnLevel:
color = yellow
case log.ErrorLevel, log.FatalLevel, log.PanicLevel:
color = red
default:
color = blue
}
}
w.writeField(strings.ToUpper(padMax(e.Level.String(), trace.DefaultLevelPadding)), color)
case "component":
padding := trace.DefaultComponentPadding
if tf.ComponentPadding != 0 {
padding = tf.ComponentPadding
}
if w.Len() > 0 {
w.WriteByte(' ')
}
value := e.Data[trace.Component]
var component string
if reflect.ValueOf(value).IsValid() {
component = fmt.Sprintf("[%v]", value)
}
component = strings.ToUpper(padMax(component, padding))
if component[len(component)-1] != ' ' {
component = component[:len(component)-1] + "]"
}
w.WriteString(component)
default:
if !KnownFormatFields.has(match) {
return nil, trace.BadParameter("invalid log format key: %v", match)
}
}
}
// always use message
if e.Message != "" {
w.writeField(e.Message, noColor)
}
if len(e.Data) > 0 {
w.writeMap(e.Data)
}
// write caller last if enabled
if tf.callerEnabled && caller != "" {
w.writeField(caller, noColor)
}
w.WriteByte('\n')
data = w.Bytes()
return data, nil
}
// jsonFormatter implements the logrus.Formatter interface and adds extra
// fields to log entries
type jsonFormatter struct {
log.JSONFormatter
extraFields []string
callerEnabled bool
componentEnabled bool
}
// CheckAndSetDefaults checks and sets log format configuration
func (j *jsonFormatter) CheckAndSetDefaults() error {
// set log formatting
if j.extraFields == nil {
j.extraFields = KnownFormatFields.names()
}
// parse input
res, err := parseInputFormat(j.extraFields)
if err != nil {
return trace.Wrap(err)
}
if utils.SliceContainsStr(res, timestampField) {
j.JSONFormatter.DisableTimestamp = true
}
if utils.SliceContainsStr(res, callerField) {
j.callerEnabled = true
}
if utils.SliceContainsStr(res, componentField) {
j.componentEnabled = true
}
// rename default fields
j.JSONFormatter = log.JSONFormatter{
FieldMap: log.FieldMap{
log.FieldKeyTime: timestampField,
log.FieldKeyLevel: levelField,
log.FieldKeyMsg: messageField,
},
}
return nil
}
// Format implements logrus.Formatter interface
func (j *jsonFormatter) Format(e *log.Entry) ([]byte, error) {
if j.callerEnabled {
path := formatCallerWithPathAndLine()
e.Data[callerField] = path
}
if j.componentEnabled {
e.Data[componentField] = e.Data[trace.Component]
}
delete(e.Data, trace.Component)
return j.JSONFormatter.Format(e)
}
func (w *writer) writeError(value interface{}) {
switch err := value.(type) {
case trace.Error:
w.WriteString(fmt.Sprintf("[%v]", err.DebugReport()))
default:
w.WriteString(fmt.Sprintf("[%v]", value))
}
}
func padMax(in string, chars int) string {
switch {
case len(in) < chars:
return in + strings.Repeat(" ", chars-len(in))
default:
return in[:chars]
}
}
func (w *writer) writeField(value interface{}, color int) {
if w.Len() > 0 {
w.WriteByte(' ')
}
w.writeValue(value, color)
}
func needsQuoting(text string) bool {
for _, r := range text {
if !strconv.IsPrint(r) {
return true
}
}
return false
}
func (w *writer) writeKeyValue(key string, value interface{}) {
if w.Len() > 0 {
w.WriteByte(' ')
}
w.WriteString(key)
w.WriteByte(':')
if key == log.ErrorKey {
w.writeError(value)
return
}
w.writeValue(value, noColor)
}
func (w *writer) writeValue(value interface{}, color int) {
var s string
switch v := value.(type) {
case string:
s = v
if needsQuoting(s) {
s = fmt.Sprintf("%q", v)
}
default:
s = fmt.Sprintf("%v", v)
}
if color != noColor {
s = fmt.Sprintf("\x1b[%dm%s\x1b[0m", color, s)
}
w.WriteString(s)
}
func (w *writer) writeMap(m map[string]interface{}) {
if len(m) == 0 {
return
}
keys := make([]string, 0, len(m))
for key := range m {
keys = append(keys, key)
}
sort.Strings(keys)
for _, key := range keys {
if key == trace.Component {
continue
}
switch value := m[key].(type) {
case log.Fields:
w.writeMap(value)
default:
w.writeKeyValue(key, value)
}
}
}
type frameCursor struct {
// current specifies the current stack frame.
// if omitted, rest contains the complete stack
current *runtime.Frame
// rest specifies the rest of stack frames to explore
rest *runtime.Frames
// n specifies the total number of stack frames
n int
}
// formatCallerWithPathAndLine formats the caller in the form path/segment:<line number>
// for output in the log
func formatCallerWithPathAndLine() (path string) {
if cursor := findFrame(); cursor != nil {
t := newTraceFromFrames(*cursor, nil)
return t.Loc()
}
return ""
}
var frameIgnorePattern = regexp.MustCompile(`github\.com/(gravitational|(S|s)irupsen)/logrus`)
// findFrames positions the stack pointer to the first
// function that does not match the frameIngorePattern
// and returns the rest of the stack frames
func findFrame() *frameCursor {
var buf [32]uintptr
// Skip enough frames to start at user code.
// This number is a mere hint to the following loop
// to start as close to user code as possible and getting it right is not mandatory.
// The skip count might need to get updated if the call to findFrame is
// moved up/down the call stack
n := runtime.Callers(4, buf[:])
pcs := buf[:n]
frames := runtime.CallersFrames(pcs)
for i := 0; i < n; i++ {
frame, _ := frames.Next()
if !frameIgnorePattern.MatchString(frame.File) {
return &frameCursor{
current: &frame,
rest: frames,
n: n,
}
}
}
return nil
}
func newTraceFromFrames(cursor frameCursor, err error) *trace.TraceErr {
traces := make(trace.Traces, 0, cursor.n)
if cursor.current != nil {
traces = append(traces, frameToTrace(*cursor.current))
}
for {
frame, more := cursor.rest.Next()
traces = append(traces, frameToTrace(frame))
if !more {
break
}
}
return &trace.TraceErr{
Err: err,
Traces: traces,
}
}
func frameToTrace(frame runtime.Frame) trace.Trace {
return trace.Trace{
Func: frame.Function,
Path: frame.File,
Line: frame.Line,
}
}
func (r knownFormatFieldsMap) has(name string) bool {
_, ok := r[name]
return ok
}
func (r knownFormatFieldsMap) names() (result []string) {
for k := range r {
result = append(result, k)
}
return result
}
type knownFormatFieldsMap map[string]struct{}
// KnownFormatFields are the known fields for log entries
var KnownFormatFields = knownFormatFieldsMap{
levelField: {},
componentField: {},
callerField: {},
timestampField: {},
}
func parseInputFormat(formatInput []string) (result []string, err error) {
for _, component := range formatInput {
component = strings.TrimSpace(component)
if !KnownFormatFields.has(component) {
return nil, trace.BadParameter("invalid log format key: %q", component)
}
result = append(result, component)
}
return result, nil
}