This repository has been archived by the owner on Dec 31, 2023. It is now read-only.
/
txt.fmtr.go
506 lines (434 loc) · 13.1 KB
/
txt.fmtr.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
/*
* Copyright © 2019 Hedzr Yeh.
*/
package formatter
import (
"bytes"
"fmt"
"os"
"path/filepath"
"runtime"
"sort"
"strings"
"sync"
"time"
"github.com/sirupsen/logrus"
"github.com/hedzr/log/dir"
)
const (
defaultTimestampFormat = time.RFC3339
black = 30
red = 31
green = 32
yellow = 33
blue = 34
magenta = 35
cyan = 36
lightGray = 37
darkGray = 90
lightRed = 91
lightGreen = 92
lightYellow = 93
lightBlue = 94
lightMagenta = 95
lightCyan = 96
white = 97
bgNormal = 0
bgBoldOrBright = 1
bgDim = 2
bgUnderline = 4
bgUlink = 5
bgHidden = 8
darkColor = lightGray
SKIP = "SKIP"
)
var baseTimestamp time.Time
func init() {
baseTimestamp = time.Now()
}
// TextFormatter formats logs into text
type TextFormatter struct {
// Set to true to bypass checking for a TTY before outputting colors.
ForceColors bool
// Force disabling colors.
DisableColors bool
// Override coloring based on CLICOLOR and CLICOLOR_FORCE. - https://bixense.com/clicolors/
EnvironmentOverrideColors bool
// Disable timestamp logging. useful when output is redirected to logging
// system that already adds timestamps.
DisableTimestamp bool
// Enable logging the full timestamp when a TTY is attached instead of just
// the time passed since beginning of execution.
FullTimestamp bool
// TimestampFormat to use for display when a full timestamp is printed
TimestampFormat string
// The fields are sorted by default for a consistent output. For applications
// that log extremely frequently and don't use the JSON formatter this may not
// be desired.
DisableSorting bool
// The keys sorting function, when uninitialized it uses sort.Strings.
SortingFunc func([]string)
// Disables the truncation of the level text to 4 characters.
DisableLevelTruncation bool
// QuoteEmptyFields will wrap empty fields in quotes if true
QuoteEmptyFields bool
// Whether the logger's out is to a terminal
isTerminal bool
// FieldMap allows users to customize the names of keys for default fields.
// As an example:
// formatter := &TextFormatter{
// FieldMap: FieldMap{
// FieldKeyTime: "@timestamp",
// FieldKeyLevel: "@level",
// FieldKeyMsg: "@message"}}
FieldMap logrus.FieldMap
// CallerPrettyfier can be set by the user to modify the content
// of the function and file keys in the json data when ReportCaller is
// activated. If any of the returned value is the empty string the
// corresponding key will be removed from json fields.
CallerPrettyfier func(*runtime.Frame) (function string, file string)
Skip int
EnableSkip bool
terminalInitOnce sync.Once
RelativePath bool
// HideHomeDir bool
currDir string
}
func (f *TextFormatter) init(entry *logrus.Entry) {
if entry.Logger != nil {
f.isTerminal = checkIfTerminal(entry.Logger.Out)
if f.isTerminal {
initTerminal(entry.Logger.Out)
}
}
f.currDir = dir.GetCurrentDir()
}
func (f *TextFormatter) isColored() bool {
isColored := f.ForceColors || (f.isTerminal && (runtime.GOOS != "windows"))
if f.EnvironmentOverrideColors {
if force, ok := os.LookupEnv("CLICOLOR_FORCE"); ok && force != "0" {
isColored = true
} else if ok && force == "0" {
isColored = false
} else if os.Getenv("CLICOLOR") == "0" {
isColored = false
}
}
return isColored && !f.DisableColors
}
var (
callerInitOnce sync.Once
logrusPackage string
logexPackage string
logPackage string
minimumCallerDepth int
)
const (
maximumCallerDepth int = 25
knownLogrusFrames int = 4
)
// getPackageName reduces a fully qualified function name to the package name
// There really ought to be to be a better way...
func getPackageName(f string) string {
for {
lastPeriod := strings.LastIndex(f, ".")
lastSlash := strings.LastIndex(f, "/")
if lastPeriod > lastSlash {
f = f[:lastPeriod]
} else {
break
}
}
return f
}
// getCaller retrieves the name of the first non-logrus calling function
func getCaller(skipFrames int) *runtime.Frame {
// cache this package's fully-qualified name
callerInitOnce.Do(func() {
pcs := make([]uintptr, 2)
_ = runtime.Callers(0, pcs)
logPackage = "github.com/hedzr/log"
logexPackage = getPackageName(runtime.FuncForPC(pcs[1]).Name())
logrusPackage = "github.com/sirupsen/logrus"
// now that we have the cache, we can skip a minimum count of known-logrus functions
// XXX this is dubious, the number of frames may vary
minimumCallerDepth = knownLogrusFrames
})
// Restrict the lookback frames to avoid runaway lookups
pcs := make([]uintptr, maximumCallerDepth)
depth := runtime.Callers(minimumCallerDepth /*+skipFrames*/, pcs)
frames := runtime.CallersFrames(pcs[:depth])
skipped := 0
for f, again := frames.Next(); again; f, again = frames.Next() {
pkg := getPackageName(f.Function)
// If the caller isn't part of this package, we're done
if pkg != "log" && pkg != "fmt" &&
!strings.HasPrefix(pkg, logrusPackage) &&
!strings.HasPrefix(pkg, logexPackage) &&
!strings.HasPrefix(pkg, logPackage) &&
!strings.HasSuffix(pkg, "log") &&
!strings.HasPrefix(f.Function, ".logf") {
if skipped < skipFrames {
skipped++
continue
}
return &f
}
}
// if we got here, we failed to find the caller's context
return nil
}
// Format renders a single log entry
func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error) {
data := make(logrus.Fields)
for k, v := range entry.Data {
data[k] = v
}
prefixFieldClashes(data, f.FieldMap, entry.HasCaller())
keys := make([]string, 0, len(data))
for k := range data {
keys = append(keys, k)
}
var funcVal, fileVal string
fixedKeys := make([]string, 0, 4+len(data))
if !f.DisableTimestamp {
fixedKeys = append(fixedKeys, resolve(f.FieldMap, logrus.FieldKeyTime))
}
fixedKeys = append(fixedKeys, resolve(f.FieldMap, logrus.FieldKeyLevel))
if entry.Message != "" {
fixedKeys = append(fixedKeys, resolve(f.FieldMap, logrus.FieldKeyMsg))
}
// NOTICE if entry.err != "" {
// fixedKeys = append(fixedKeys, resolve(f.FieldMap, logrus.FieldKeyLogrusError))
// }
if entry.HasCaller() {
fixedKeys = append(fixedKeys,
resolve(f.FieldMap, logrus.FieldKeyFunc), resolve(f.FieldMap, logrus.FieldKeyFile))
if f.CallerPrettyfier != nil {
funcVal, fileVal = f.CallerPrettyfier(entry.Caller)
} else {
funcVal = entry.Caller.Function
if ff, ok := data[resolve(f.FieldMap, logrus.FieldKeyFile)]; ok && strings.Contains(entry.Caller.File, "logrus.go") {
fileVal = ff.(string)
} else {
var sf interface{}
ok, fb := false, false
if f.EnableSkip && f.Skip >= 0 {
sf, ok = f.Skip, true
// } else if !f.EnableSkip {
// sf, ok = 1, true
} else {
sf = int(0)
}
if v, yes := data[SKIP]; yes {
sf, ok = sf.(int)+v.(int), yes
}
if ok {
if skipFrames, ok := sf.(int); ok && skipFrames >= 0 {
// println("skipFrames: %v", skipFrames)
fb = true
delete(data, SKIP)
for i, k := range keys {
if k == SKIP {
keys[i] = "via"
}
}
// data["via"] = fmt.Sprintf("%s:%d (%v)", entry.Caller.File, entry.Caller.Line, funcVal)
data["via"] = fmt.Sprintf("%v", funcVal)
entryCaller := getCaller(skipFrames)
if entryCaller != nil {
fileVal = fmt.Sprintf("%s:%d", entryCaller.File, entryCaller.Line)
// funcVal = entryCaller.Function
entry.Caller = entryCaller
}
}
}
// fmt.Printf("runtime-version: %v, skipFrames: %v. ok: %v, EnableSkip: %v, %v. fb: %v. logexPackage: %v.\n", runtime.Version(), sf, ok, f.EnableSkip, f.Skip, fb, logexPackage)
if !fb {
fileVal = fmt.Sprintf("%s:%d", entry.Caller.File, entry.Caller.Line)
}
}
}
}
if !f.DisableSorting {
if f.SortingFunc == nil {
sort.Strings(keys)
fixedKeys = append(fixedKeys, keys...)
} else {
if !f.isColored() {
fixedKeys = append(fixedKeys, keys...)
f.SortingFunc(fixedKeys)
} else {
f.SortingFunc(keys)
}
}
} else {
fixedKeys = append(fixedKeys, keys...)
}
var b *bytes.Buffer
if entry.Buffer != nil {
b = entry.Buffer
} else {
b = &bytes.Buffer{}
}
f.terminalInitOnce.Do(func() { f.init(entry) })
timestampFormat := f.TimestampFormat
if timestampFormat == "" {
timestampFormat = defaultTimestampFormat
}
if f.isColored() {
f.printColored(b, entry, keys, data, timestampFormat)
} else {
for _, key := range fixedKeys {
var value interface{}
switch {
case key == resolve(f.FieldMap, logrus.FieldKeyTime):
value = entry.Time.Format(timestampFormat)
case key == resolve(f.FieldMap, logrus.FieldKeyLevel):
value = entry.Level.String()
case key == resolve(f.FieldMap, logrus.FieldKeyMsg):
value = entry.Message
// NOTICE case key == resolve(f.FieldMap, logrus.FieldKeyLogrusError):
// value = entry.err
case key == resolve(f.FieldMap, logrus.FieldKeyFunc) && entry.HasCaller():
value = funcVal
case key == resolve(f.FieldMap, logrus.FieldKeyFile) && entry.HasCaller():
value = fileVal
default:
value = data[key]
}
f.appendKeyValue(b, key, value)
}
}
b.WriteByte('\n')
return b.Bytes(), nil
}
func sel(ss ...string) (ret string) {
for _, s := range ss {
if len(s) > 0 {
ret = s
break
}
}
return
}
func (f *TextFormatter) stripKnownPrefixes(file string) (ret string) {
// ret = file
// if f.HideHomeDir {
// cd := dir.GetCurrentDir()
// for _, it := range []struct{ find, repl string }{
// {cd, "."},
// {sel(os.Getenv("HOME"), os.Getenv("USERPROFILE")), "~"},
// } {
// if strings.HasPrefix(ret, it.find) {
// //ret = ret[len(p):]
// ret = it.repl + ret[len(it.find):]
// break
// }
// }
// }
ret = file
if f.RelativePath {
rp, err := filepath.Rel(f.currDir, file)
if err == nil {
ret = rp
}
}
return
}
func (f *TextFormatter) printColored(b *bytes.Buffer, entry *logrus.Entry, keys []string, data logrus.Fields, timestampFormat string) {
var levelColor int
switch entry.Level {
case logrus.DebugLevel, logrus.TraceLevel:
levelColor = darkGray // lightGray
case logrus.WarnLevel:
levelColor = yellow
case logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel:
levelColor = red
default:
levelColor = cyan
}
levelText := strings.ToUpper(entry.Level.String())
if !f.DisableLevelTruncation {
levelText = levelText[0:4]
}
// Remove a single newline if it already exists in the message to keep
// the behavior of logrus text_formatter the same as the stdlib log package
entry.Message = strings.TrimSuffix(entry.Message, "\n")
caller := ""
skipFile := false
skipVia := true
if entry.HasCaller() {
funcVal := fmt.Sprintf("\u001B[%dm%s\u001B[0m()", darkGray, entry.Caller.Function)
funcVal = strings.ReplaceAll(funcVal, "github.com", "GH")
funcVal = strings.ReplaceAll(funcVal, "gitlab.com", "GL")
funcVal = strings.ReplaceAll(funcVal, "gitee.com", "GT")
funcVal = strings.ReplaceAll(funcVal, "bitbucket.com", "BB")
var fileVal string // fileVal := fmt.Sprintf("%s:%d", entry.Caller.File, entry.Caller.Line)
if f1, ok := data[resolve(f.FieldMap, logrus.FieldKeyFile)]; ok && strings.Contains(entry.Caller.File, "logrus.go") {
fileVal = f.stripKnownPrefixes(f1.(string))
skipFile = true
} else {
fileVal = fmt.Sprintf("\u001B[%dm%s:%d\u001B[0m", lightBlue, f.stripKnownPrefixes(entry.Caller.File), entry.Caller.Line)
}
if f.CallerPrettyfier != nil {
funcVal, fileVal = f.CallerPrettyfier(entry.Caller)
}
caller = fileVal + " " + funcVal
}
if f.DisableTimestamp {
_, _ = fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m %-48s %s ", levelColor, levelText, entry.Message, caller)
} else if !f.FullTimestamp {
// echo -e "Normal \e[2mDim"
// skipVia = false
_, _ = fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m\x1b[2m \x1b[%dm[%04d]\x1b[0m %-48s \x1b[2m\x1b[%dm%s\x1b[0m ",
levelColor, levelText, darkColor, int(entry.Time.Sub(baseTimestamp)/time.Second), entry.Message, darkColor, caller)
} else {
_, _ = fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m \u001B[%dm[%s]\u001B[0m %-48s %s ",
levelColor, levelText, darkColor, entry.Time.Format(timestampFormat), entry.Message, caller)
}
for _, k := range keys {
if skipFile && strings.HasSuffix(k, resolve(f.FieldMap, logrus.FieldKeyFile)) {
continue
}
if skipVia && k == "via" {
continue
}
v := data[k]
_, _ = fmt.Fprintf(b, " \x1b[%dm%s\x1b[0m=", levelColor, k)
f.appendValue(b, v)
}
}
func (f *TextFormatter) needsQuoting(text string) bool {
if f.QuoteEmptyFields && len(text) == 0 {
return true
}
for _, ch := range text {
if !((ch >= 'a' && ch <= 'z') ||
(ch >= 'A' && ch <= 'Z') ||
(ch >= '0' && ch <= '9') ||
ch == '-' || ch == '.' || ch == '_' || ch == '/' || ch == '@' || ch == '^' || ch == '+') {
return true
}
}
return false
}
func (f *TextFormatter) appendKeyValue(b *bytes.Buffer, key string, value interface{}) {
if b.Len() > 0 {
b.WriteByte(' ')
}
b.WriteString(key)
b.WriteByte('=')
f.appendValue(b, value)
}
func (f *TextFormatter) appendValue(b *bytes.Buffer, value interface{}) {
stringVal, ok := value.(string)
if !ok {
stringVal = fmt.Sprint(value)
}
if !f.needsQuoting(stringVal) {
b.WriteString(stringVal)
} else {
b.WriteString(fmt.Sprintf("%q", stringVal))
}
}