-
Notifications
You must be signed in to change notification settings - Fork 272
/
logger.go
253 lines (192 loc) · 5.47 KB
/
logger.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
package logger
import (
"fmt"
"io"
"os"
"time"
)
// Logger is an interface for logger.
type Logger interface {
Factory
// Level returns the current logger's level.
Level() Level
Namespace() string
// IsLevelEnabled returns true when Level is enabled, false otherwise.
IsLevelEnabled(level Level) bool
// Trace adds a log entry with level trace.
Trace(message string, ctx Ctx) (int, error)
// Debug adds a log entry with level debug.
Debug(message string, ctx Ctx) (int, error)
// Info adds a log entry with level info.
Info(message string, ctx Ctx) (int, error)
// Warn adds a log entry with level warn.
Warn(message string, ctx Ctx) (int, error)
// Error adds a log entry with level error.
Error(message string, err error, ctx Ctx) (int, error)
}
type Factory interface {
// Ctx returns the current logger's context.
Ctx() Ctx
// WithCtx returns a new Logger with context appended to existing context.
WithCtx(Ctx) Logger
// WithFormatter returns a new Logger with formatter set.
WithFormatter(Formatter) Logger
// WithWriter returns a new Logger with writer set.
WithWriter(io.Writer) Logger
// WithNamespace returns a new Logger with namespace set.
WithNamespace(namespace string) Logger
// WithNamespaceAppended returns a new Logger with namespace appended.
WithNamespaceAppended(namespace string) Logger
// WithConfig returns a new Logger with config set.
WithConfig(config Config) Logger
}
// logger is a logger that writes to io.Writer when it is enabled.
type logger struct {
config Config
ctx Ctx
formatter Formatter
level Level
namespace string
writer io.Writer
}
// New returns a new Logger with default StringFormatter. Be sure to call
// WithConfig to set the required levels for different namespaces.
func New() Logger {
return &logger{
config: LevelDisabled,
ctx: nil,
formatter: NewStringFormatter(StringFormatterParams{}),
level: LevelUnknown,
namespace: "",
writer: os.Stderr,
}
}
func NewFromEnv(key string) Logger {
envConfig := os.Getenv(key)
return New().WithConfig(NewConfigFromString(envConfig))
}
// compile-time assertion that logger implements Logger.
var _ Logger = &logger{}
// Ctx implements Logger.
func (l *logger) Ctx() Ctx {
return l.ctx
}
func (l *logger) setDefaults(old *logger) *logger {
if l.config == nil {
l.config = old.config
}
if l.ctx == nil {
l.ctx = old.ctx
}
if l.formatter == nil {
l.formatter = old.formatter
}
if l.namespace == "" {
l.namespace = old.namespace
l.level = old.level
} else {
l.level = l.config.LevelForNamespace(l.namespace)
}
if l.writer == nil {
l.writer = old.writer
}
return l
}
// WithCtx implements Logger.
func (l *logger) WithCtx(ctx Ctx) Logger {
ret := logger{ctx: l.ctx.WithCtx(ctx)}
return ret.setDefaults(l)
}
// WithFormatter implements Logger.
func (l *logger) WithFormatter(formatter Formatter) Logger {
ret := &logger{formatter: formatter}
return ret.setDefaults(l)
}
// WithWriter implements Logger.
func (l *logger) WithWriter(writer io.Writer) Logger {
ret := &logger{writer: writer}
return ret.setDefaults(l)
}
// WithNamespace implements Logger.
func (l *logger) WithNamespace(namespace string) Logger {
ret := logger{namespace: namespace}
return ret.setDefaults(l)
}
// WithNamespaceAppended implements Logger.
func (l *logger) WithNamespaceAppended(newNamespace string) Logger {
oldNamespace := l.namespace
if oldNamespace != "" {
newNamespace = fmt.Sprintf("%s:%s", oldNamespace, newNamespace)
}
return l.WithNamespace(newNamespace)
}
// WithConfig implements Logger.
func (l *logger) WithConfig(config Config) Logger {
ret := &logger{config: config}
return ret.setDefaults(l)
}
// Level implements Logger.
func (l *logger) Namespace() string {
return l.namespace
}
// Level implements Logger.
func (l *logger) Level() Level {
return l.config.LevelForNamespace(l.namespace)
}
// Trace implements Logger.
func (l *logger) Trace(message string, ctx Ctx) (int, error) {
i, err := l.log(time.Now(), LevelTrace, message, ctx)
return i, err
}
// Debug implements Logger.
func (l *logger) Debug(message string, ctx Ctx) (int, error) {
i, err := l.log(time.Now(), LevelDebug, message, ctx)
return i, err
}
// Info implements Logger.
func (l *logger) Info(message string, ctx Ctx) (int, error) {
i, err := l.log(time.Now(), LevelInfo, message, ctx)
return i, err
}
// Warn implements Logger.
func (l *logger) Warn(message string, ctx Ctx) (int, error) {
i, err := l.log(time.Now(), LevelWarn, message, ctx)
return i, err
}
// Error implements Logger.
func (l *logger) Error(message string, err error, ctx Ctx) (int, error) {
if err != nil {
if message != "" {
message = fmt.Sprintf("%s: %+v", message, err)
} else {
message = fmt.Sprintf("%+v", err)
}
}
i, err := l.log(time.Now(), LevelError, message, ctx)
return i, err
}
// IsLevelEnabled implements Logger.
func (l *logger) IsLevelEnabled(level Level) bool {
configuredLevel := l.Level()
return configuredLevel > 0 && level <= configuredLevel
}
func (l *logger) log(ts time.Time, level Level, message string, ctx Ctx) (int, error) {
if !l.IsLevelEnabled(level) {
return 0, nil
}
formatted, err := l.formatter.Format(Message{
Timestamp: ts,
Namespace: l.namespace,
Level: level,
Body: message,
Ctx: l.ctx.WithCtx(ctx),
})
if err != nil {
return 0, fmt.Errorf("log format error: %w", err)
}
i, err := l.writer.Write(formatted)
if err != nil {
return i, fmt.Errorf("log write error: %w", err)
}
return i, nil
}