-
Notifications
You must be signed in to change notification settings - Fork 25
/
formatter_text.go
169 lines (151 loc) · 4.24 KB
/
formatter_text.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
package slog
import (
"github.com/gookit/color"
"github.com/valyala/bytebufferpool"
)
// there are built in text log template
const (
DefaultTemplate = "[{{datetime}}] [{{channel}}] [{{level}}] [{{caller}}] {{message}} {{data}} {{extra}}\n"
NamedTemplate = "{{datetime}} channel={{channel}} level={{level}} [file={{caller}}] message={{message}} data={{data}}\n"
)
// ColorTheme for format log to console
var ColorTheme = map[Level]color.Color{
PanicLevel: color.FgRed,
FatalLevel: color.FgRed,
ErrorLevel: color.FgMagenta,
WarnLevel: color.FgYellow,
NoticeLevel: color.OpBold,
InfoLevel: color.FgGreen,
DebugLevel: color.FgCyan,
// TraceLevel: color.FgLightGreen,
}
// TextFormatter definition
type TextFormatter struct {
// template text template for render output log messages
template string
// fields list, parsed from template string.
// NOTICE: fields contains no-field items.
// eg: ["level", "}}"}
fields []string
// TimeFormat the time format layout. default is time.RFC3339
TimeFormat string
// Enable color on print log to terminal
EnableColor bool
// ColorTheme setting on render color on terminal
ColorTheme map[Level]color.Color
// FullDisplay Whether to display when record.Data, record.Extra, etc. are empty
FullDisplay bool
// EncodeFunc data encode for Record.Data, Record.Extra, etc.
// Default is encode by EncodeToString()
EncodeFunc func(v any) string
}
// NewTextFormatter create new TextFormatter
func NewTextFormatter(template ...string) *TextFormatter {
var fmtTpl string
if len(template) > 0 {
fmtTpl = template[0]
} else {
fmtTpl = DefaultTemplate
}
f := &TextFormatter{
// default options
TimeFormat: DefaultTimeFormat,
ColorTheme: ColorTheme,
// EnableColor: color.SupportColor(),
// EncodeFunc: func(v interface{}) string {
// return fmt.Sprint(v)
// },
EncodeFunc: EncodeToString,
}
f.SetTemplate(fmtTpl)
return f
}
// SetTemplate set the log format template and update field-map
func (f *TextFormatter) SetTemplate(fmtTpl string) {
// ensure last char is newline.
// if fmtTpl[len(fmtTpl)-1] != '\n' {
// fmtTpl += "\n"
// }
f.template = fmtTpl
f.fields = parseTemplateToFields(fmtTpl)
}
// Template get
func (f *TextFormatter) Template() string {
return f.template
}
// Fields get export field list
func (f *TextFormatter) Fields() []string {
ss := make([]string, 0, len(f.fields)/2)
for _, s := range f.fields {
if s[0] >= 'a' && s[0] <= 'z' {
ss = append(ss, s)
}
}
return ss
}
// Format a log record
//
//goland:noinspection GoUnhandledErrorResult
func (f *TextFormatter) Format(r *Record) ([]byte, error) {
buf := bytebufferpool.Get()
buf.Reset()
defer bytebufferpool.Put(buf)
for _, field := range f.fields {
// is not field name. eg: "}}] "
if field[0] < 'a' || field[0] > 'z' {
// remove left "}}"
if len(field) > 1 && field[0:2] == "}}" {
buf.WriteString(field[2:])
} else {
buf.WriteString(field)
}
continue
}
switch {
case field == FieldKeyDatetime:
buf.WriteString(r.Time.Format(f.TimeFormat))
case field == FieldKeyTimestamp:
buf.WriteString(r.timestamp())
case field == FieldKeyCaller && r.Caller != nil:
buf.WriteString(formatCaller(r.Caller, r.CallerFlag))
case field == FieldKeyLevel:
// output colored logs for console
if f.EnableColor {
buf.WriteString(f.renderColorByLevel(r.LevelName(), r.Level))
} else {
buf.WriteString(r.LevelName())
}
case field == FieldKeyChannel:
buf.WriteString(r.Channel)
case field == FieldKeyMessage:
// output colored logs for console
if f.EnableColor {
buf.WriteString(f.renderColorByLevel(r.Message, r.Level))
} else {
buf.WriteString(r.Message)
}
case field == FieldKeyData:
if f.FullDisplay || len(r.Data) > 0 {
buf.WriteString(f.EncodeFunc(r.Data))
}
case field == FieldKeyExtra:
if f.FullDisplay || len(r.Extra) > 0 {
buf.WriteString(f.EncodeFunc(r.Extra))
}
default:
if _, ok := r.Fields[field]; ok {
buf.WriteString(f.EncodeFunc(r.Fields[field]))
} else {
buf.WriteString(field)
}
}
}
// return buf.Bytes(), nil
return buf.B, nil
}
func (f *TextFormatter) renderColorByLevel(text string, level Level) string {
if theme, ok := f.ColorTheme[level]; ok {
return theme.Render(text)
}
return text
}