-
Notifications
You must be signed in to change notification settings - Fork 36
/
logger.go
409 lines (334 loc) · 10.2 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
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
package zap
import (
"context"
"fmt"
"strconv"
"sync/atomic"
"unsafe"
"go.uber.org/multierr"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/bnb-chain/greenfield-storage-provider/pkg/log/internal/metadata"
"github.com/bnb-chain/greenfield-storage-provider/pkg/log/internal/types"
)
const (
baseCallDepth = 2
LevelKey = "l"
TimeKey = "t"
CallerKey = "caller"
MessageKey = "msg"
)
var _ types.Logger = (*logger)(nil)
type logger struct {
level *levelEnabler
writer *asyncWriterProxy
base *zap.Logger
}
func NewLogger(lvl types.Level, w types.AsyncWriter) *logger {
encoderConfig := zapcore.EncoderConfig{
LevelKey: LevelKey,
TimeKey: TimeKey,
NameKey: zapcore.OmitKey,
CallerKey: CallerKey,
FunctionKey: zapcore.OmitKey,
MessageKey: MessageKey,
StacktraceKey: "stacktrace",
LineEnding: zapcore.DefaultLineEnding,
EncodeLevel: zapcore.LowercaseLevelEncoder,
EncodeTime: zapcore.ISO8601TimeEncoder,
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.ShortCallerEncoder,
}
l := &logger{
level: newLevelEnabler(toZapLevel(lvl)),
writer: newAsyncWriter(w),
base: nil,
}
core := zapcore.NewCore(newZapJSONEncoder(encoderConfig, false), l.writer, l.level)
l.base = zap.New(core,
zap.AddCaller(),
zap.AddCallerSkip(baseCallDepth),
zap.AddStacktrace(zap.PanicLevel),
)
l.base.Sugar()
return l
}
func toZapLevel(lvl types.Level) zapcore.Level {
switch lvl {
case types.DebugLevel:
return zap.DebugLevel
case types.InfoLevel:
return zap.InfoLevel
case types.WarnLevel:
return zap.WarnLevel
case types.ErrorLevel:
return zap.ErrorLevel
case types.PanicLevel:
return zap.PanicLevel
default:
return zap.InfoLevel
}
}
func (zl *logger) SetLevel(lvl types.Level) {
zl.level.SetLevel(toZapLevel(lvl))
}
func (zl *logger) SetWriter(w types.AsyncWriter) {
zl.writer.SetWriter(w)
}
func (zl *logger) AddCallerSkip(skip int) types.Logger {
return &logger{
level: zl.level,
writer: zl.writer,
base: zl.base.WithOptions(zap.AddCallerSkip(skip)),
}
}
func (zl *logger) With(args ...interface{}) types.Logger {
return &logger{
level: zl.level,
writer: zl.writer,
base: zl.base.With(zl.sweetenFields(args, 0)...),
}
}
func (zl *logger) Debug(args ...interface{}) {
zl.log(zap.DebugLevel, nil, "", args, nil)
}
func (zl *logger) Info(args ...interface{}) {
zl.log(zap.InfoLevel, nil, "", args, nil)
}
func (zl *logger) Warn(args ...interface{}) {
zl.log(zap.WarnLevel, nil, "", args, nil)
}
func (zl *logger) Error(args ...interface{}) {
zl.log(zap.ErrorLevel, nil, "", args, nil)
}
func (zl *logger) Panic(args ...interface{}) {
zl.log(zap.PanicLevel, nil, "", args, nil)
}
func (zl *logger) Debugf(fmt string, args ...interface{}) {
zl.log(zap.DebugLevel, nil, fmt, args, nil)
}
func (zl *logger) Infof(fmt string, args ...interface{}) {
zl.log(zap.InfoLevel, nil, fmt, args, nil)
}
func (zl *logger) Warnf(fmt string, args ...interface{}) {
zl.log(zap.WarnLevel, nil, fmt, args, nil)
}
func (zl *logger) Errorf(fmt string, args ...interface{}) {
zl.log(zap.ErrorLevel, nil, fmt, args, nil)
}
func (zl *logger) Panicf(fmt string, args ...interface{}) {
zl.log(zap.PanicLevel, nil, fmt, args, nil)
}
func (zl *logger) Debugw(msg string, kvs ...interface{}) {
zl.log(zap.DebugLevel, nil, msg, nil, kvs)
}
func (zl *logger) Infow(msg string, kvs ...interface{}) {
zl.log(zap.InfoLevel, nil, msg, nil, kvs)
}
func (zl *logger) Warnw(msg string, kvs ...interface{}) {
zl.log(zap.WarnLevel, nil, msg, nil, kvs)
}
func (zl *logger) Errorw(msg string, kvs ...interface{}) {
zl.log(zap.ErrorLevel, nil, msg, nil, kvs)
}
func (zl *logger) Panicw(msg string, kvs ...interface{}) {
zl.log(zap.PanicLevel, nil, msg, nil, kvs)
}
func (zl *logger) CtxDebug(ctx context.Context, args ...interface{}) {
zl.log(zap.DebugLevel, ctx, "", args, nil)
}
func (zl *logger) CtxInfo(ctx context.Context, args ...interface{}) {
zl.log(zap.InfoLevel, ctx, "", args, nil)
}
func (zl *logger) CtxWarn(ctx context.Context, args ...interface{}) {
zl.log(zap.WarnLevel, ctx, "", args, nil)
}
func (zl *logger) CtxError(ctx context.Context, args ...interface{}) {
zl.log(zap.ErrorLevel, ctx, "", args, nil)
}
func (zl *logger) CtxPanic(ctx context.Context, args ...interface{}) {
zl.log(zap.PanicLevel, ctx, "", args, nil)
}
func (zl *logger) CtxDebugf(ctx context.Context, fmt string, args ...interface{}) {
zl.log(zap.DebugLevel, ctx, fmt, args, nil)
}
func (zl *logger) CtxInfof(ctx context.Context, fmt string, args ...interface{}) {
zl.log(zap.InfoLevel, ctx, fmt, args, nil)
}
func (zl *logger) CtxWarnf(ctx context.Context, fmt string, args ...interface{}) {
zl.log(zap.WarnLevel, ctx, fmt, args, nil)
}
func (zl *logger) CtxErrorf(ctx context.Context, fmt string, args ...interface{}) {
zl.log(zap.ErrorLevel, ctx, fmt, args, nil)
}
func (zl *logger) CtxPanicf(ctx context.Context, fmt string, args ...interface{}) {
zl.log(zap.PanicLevel, ctx, fmt, args, nil)
}
func (zl *logger) CtxDebugw(ctx context.Context, msg string, kvs ...interface{}) {
zl.log(zap.DebugLevel, ctx, msg, nil, kvs)
}
func (zl *logger) CtxInfow(ctx context.Context, msg string, kvs ...interface{}) {
zl.log(zap.InfoLevel, ctx, msg, nil, kvs)
}
func (zl *logger) CtxWarnw(ctx context.Context, msg string, kvs ...interface{}) {
zl.log(zap.WarnLevel, ctx, msg, nil, kvs)
}
func (zl *logger) CtxErrorw(ctx context.Context, msg string, kvs ...interface{}) {
zl.log(zap.ErrorLevel, ctx, msg, nil, kvs)
}
func (zl *logger) CtxPanicw(ctx context.Context, msg string, kvs ...interface{}) {
zl.log(zap.PanicLevel, ctx, msg, nil, kvs)
}
func (zl *logger) Stop() {
zl.writer.Stop()
}
func (zl *logger) log(lvl zapcore.Level, ctx context.Context, template string, fmtArgs []interface{}, kvs []interface{}) {
if lvl < zap.DPanicLevel && !zl.base.Core().Enabled(lvl) {
return
}
msg := zl.getMessage(template, fmtArgs)
if ce := zl.base.Check(lvl, msg); ce != nil {
fields := zl.getMetaInfo(ctx)
fields = append(fields, zl.sweetenFields(kvs, 1)...)
ce.Write(fields...)
}
}
// getMetaInfo add these field
// - trace_id
func (zl *logger) getMetaInfo(ctx context.Context) []zap.Field {
if ctx == nil {
return nil
}
fields := make([]zap.Field, 0)
if traceID, ok := metadata.GetValue(ctx, "trace_id"); ok {
fields = append(fields, zap.String("trace_id", traceID))
}
if bucketName, ok := metadata.GetValue(ctx, "bucket_name"); ok {
fields = append(fields, zap.String("bucket_name", bucketName))
}
if objectID, ok := metadata.GetValue(ctx, "object_id"); ok {
fields = append(fields, zap.String("object_id", objectID))
}
if objectName, ok := metadata.GetValue(ctx, "object_name"); ok {
fields = append(fields, zap.String("object_name", objectName))
}
if taskKey, ok := metadata.GetValue(ctx, "task_key"); ok {
fields = append(fields, zap.String("task_key", taskKey))
}
return fields
}
func (zl *logger) getMessage(template string, fmtArgs []interface{}) string {
if len(fmtArgs) == 0 {
return template
}
if template != "" {
return fmt.Sprintf(template, fmtArgs...)
}
if len(fmtArgs) == 1 {
if str, ok := fmtArgs[0].(string); ok {
return str
}
}
return fmt.Sprint(fmtArgs...)
}
const (
_oddNumberErrMsg = "Ignored key without a value."
_nonStringKeyErrMsg = "Ignored key-value pairs with non-string keys."
)
func (zl *logger) sweetenFields(args []interface{}, skipCaller int) []zap.Field {
if len(args) == 0 {
return nil
}
// Allocate enough space for the worst case; if users pass only structured
// fields, we shouldn't penalize them with extra allocations.
fields := make([]zap.Field, 0, len(args))
var invalid invalidPairs
usedFields := map[string]int{
LevelKey: 1,
TimeKey: 1,
CallerKey: 1,
MessageKey: 1,
}
for i := 0; i < len(args); {
// Make sure this element isn't a dangling key.
if i == len(args)-1 {
zl.base.WithOptions(zap.AddCallerSkip(skipCaller)).Error(_oddNumberErrMsg, zap.Any("ignored", args[i]))
break
}
// Consume this value and the next, treating them as a key-value pair. If the
// key isn't a string, add this pair to the slice of invalid pairs.
key, val := args[i], args[i+1]
if keyStr, ok := key.(string); !ok {
// Subsequent errors are likely, so allocate once up front.
if cap(invalid) == 0 {
invalid = make(invalidPairs, 0, len(args)/2)
}
invalid = append(invalid, invalidPair{i, key, val})
} else {
usedFields[keyStr] += 1
if usedFields[keyStr] > 1 {
keyStr += strconv.Itoa(usedFields[keyStr])
}
fields = append(fields, zap.Any(keyStr, val))
}
i += 2
}
// If we encountered any invalid key-value pairs, log an error.
if len(invalid) > 0 {
zl.base.WithOptions(zap.AddCallerSkip(skipCaller)).Error(_nonStringKeyErrMsg, zap.Array("invalid", invalid))
}
return fields
}
type invalidPair struct {
position int
key, value interface{}
}
func (p invalidPair) MarshalLogObject(enc zapcore.ObjectEncoder) error {
enc.AddInt64("position", int64(p.position))
zap.Any("key", p.key).AddTo(enc)
zap.Any("value", p.value).AddTo(enc)
return nil
}
type invalidPairs []invalidPair
func (ps invalidPairs) MarshalLogArray(enc zapcore.ArrayEncoder) error {
var err error
for i := range ps {
err = multierr.Append(err, enc.AppendObject(ps[i]))
}
return err
}
type levelEnabler struct {
rawLevel int32
}
func newLevelEnabler(lvl zapcore.Level) *levelEnabler {
return &levelEnabler{rawLevel: int32(lvl)}
}
func (e *levelEnabler) Enabled(lvl zapcore.Level) bool {
return lvl >= zapcore.Level(atomic.LoadInt32(&e.rawLevel))
}
func (e *levelEnabler) SetLevel(lvl zapcore.Level) {
atomic.StoreInt32(&e.rawLevel, int32(lvl))
}
type asyncWriterProxy struct {
raw unsafe.Pointer
}
func newAsyncWriter(wr types.AsyncWriter) *asyncWriterProxy {
w := &asyncWriterProxy{}
atomic.StorePointer(&w.raw, unsafe.Pointer(&wr))
return w
}
func (w *asyncWriterProxy) SetWriter(wr types.AsyncWriter) {
atomic.StorePointer(&w.raw, unsafe.Pointer(&wr))
}
func (w *asyncWriterProxy) Writer() types.AsyncWriter {
return *(*types.AsyncWriter)(atomic.LoadPointer(&w.raw))
}
func (w *asyncWriterProxy) Write(p []byte) (int, error) {
return w.Writer().Write(p)
}
func (w *asyncWriterProxy) Sync() error {
return w.Writer().Sync()
}
func (w *asyncWriterProxy) Stop() {
w.Writer().Stop()
}