-
Notifications
You must be signed in to change notification settings - Fork 332
/
logger.go
413 lines (355 loc) · 10.8 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
410
411
412
413
package logging
import (
"context"
"fmt"
"io"
"os"
"reflect"
"runtime"
"strings"
"sync"
"time"
"github.com/sirupsen/logrus"
"gopkg.in/natefinch/lumberjack.v2"
)
type contextKey string
const (
LogFieldsContextKey = contextKey("log_fields")
ProjectDirectoryName = "lakefs"
ModuleName = "github.com/treeverse/lakefs"
// durationStr is the suffix for the field holding a Duration as a
// string.
durationStr = "_str"
)
// log_fields keys
const (
// RepositoryFieldKey repository name (string)
RepositoryFieldKey = "repository"
// MatchedHostFieldKey matched host (bool) true when domain extracted from host
MatchedHostFieldKey = "matched_host"
// RefHostFieldKey reference id (string)
RefHostFieldKey = "ref"
// PathFieldKey path / request URI (string)
PathFieldKey = "path"
// UploadIDFieldKey s3 multipart upload ID (string) "upload_id"
UploadIDFieldKey = "upload_id"
// ListTypeFieldKey s3 list type version (string, ex: v1 or v2)
ListTypeFieldKey = "list_type"
// PhysicalAddressFieldKey object physical address (string)
PhysicalAddressFieldKey = "physical_address"
// PartNumberFieldKey s3 multipart upload part number (string)
PartNumberFieldKey = "part_number"
// RequestIDFieldKey request ID (string) based on the request ID found on context
RequestIDFieldKey = "request_id"
// HostFieldKey request's host (string)
HostFieldKey = "host"
// MethodFieldKey request's method (string)
MethodFieldKey = "method"
// UserFieldKey user's name associated with the request (string)
UserFieldKey = "user"
// ServiceNameFieldKey service name (string, ex: rest_api)
ServiceNameFieldKey = "service_name"
// LogAudit kind of information to audit (string, ex: API)
LogAudit = "log_audit"
)
var (
formatterInitOnce sync.Once
defaultLogger = logrus.New()
openLoggers []io.Closer
)
func Level() string {
return defaultLogger.GetLevel().String()
}
type Fields map[string]interface{}
// logCallerTrimmer is used to trim the caller paths to be relative to the project root
func logCallerTrimmer(frame *runtime.Frame) (function string, file string) {
indexOfModule := strings.Index(strings.ToLower(frame.File), ProjectDirectoryName)
if indexOfModule != -1 {
file = frame.File[indexOfModule+len(ProjectDirectoryName):]
} else {
file = frame.File
}
file = fmt.Sprintf("%s:%d", strings.TrimPrefix(file, string(os.PathSeparator)), frame.Line)
function = strings.TrimPrefix(frame.Function, fmt.Sprintf("%s%s", ModuleName, string(os.PathSeparator)))
return
}
func SetLevel(level string) {
switch strings.ToLower(level) {
case "trace":
defaultLogger.SetLevel(logrus.TraceLevel)
case "debug":
defaultLogger.SetLevel(logrus.DebugLevel)
case "info":
defaultLogger.SetLevel(logrus.InfoLevel)
case "warn", "warning":
defaultLogger.SetLevel(logrus.WarnLevel)
case "error":
defaultLogger.SetLevel(logrus.ErrorLevel)
case "panic":
defaultLogger.SetLevel(logrus.PanicLevel)
case "null", "none":
defaultLogger.SetLevel(logrus.PanicLevel)
defaultLogger.SetOutput(io.Discard)
}
}
func CloseWriters() error {
for _, c := range openLoggers {
if err := c.Close(); err != nil {
return fmt.Errorf("close log writer: %w", err)
}
}
openLoggers = nil
return nil
}
func SetOutputs(outputs []string, fileMaxSizeMB, filesKeep int) error {
var writers []io.Writer
if err := CloseWriters(); err != nil {
return fmt.Errorf("close previous log writers: %w", err)
}
for _, output := range outputs {
var w io.Writer
switch output {
case "":
continue
case "-":
w = os.Stdout
case "=":
w = os.Stderr
default:
l := &lumberjack.Logger{
Filename: output,
MaxSize: fileMaxSizeMB,
MaxBackups: filesKeep,
}
w = l
openLoggers = append(openLoggers, l)
}
writers = append(writers, w)
}
if len(writers) == 1 {
defaultLogger.SetOutput(writers[0])
} else if len(writers) > 1 {
defaultLogger.SetOutput(io.MultiWriter(writers...))
}
return nil
}
type OutputFormatOptions struct {
CallerPrettyfier func(*runtime.Frame) (function string, file string)
}
type OutputFormatOptionFunc func(options *OutputFormatOptions)
func SetOutputFormat(format string, opts ...OutputFormatOptionFunc) {
// setup options
var options OutputFormatOptions
for _, opt := range opts {
opt(&options)
}
if options.CallerPrettyfier == nil {
options.CallerPrettyfier = logCallerTrimmer
}
// setup formatter
var formatter logrus.Formatter
switch strings.ToLower(format) {
case "text":
disableColors := false
noColor := os.Getenv("NO_COLOR")
if noColor != "" && noColor != "0" {
disableColors = true
}
formatter = &logrus.TextFormatter{
FullTimestamp: true,
DisableLevelTruncation: true,
PadLevelText: true,
QuoteEmptyFields: true,
CallerPrettyfier: options.CallerPrettyfier,
DisableColors: disableColors,
}
case "json":
formatter = &logrus.JSONFormatter{
CallerPrettyfier: options.CallerPrettyfier,
PrettyPrint: false,
}
default:
return // no known formatter found
}
// wrap it with our caller formatter
defaultLogger.SetFormatter(logrusCallerFormatter{formatter})
}
type Logger interface {
WithContext(ctx context.Context) Logger
WithField(key string, value interface{}) Logger
WithFields(fields Fields) Logger
WithError(err error) Logger
Trace(args ...interface{})
Debug(args ...interface{})
Info(args ...interface{})
Warn(args ...interface{})
Warning(args ...interface{})
Error(args ...interface{})
Fatal(args ...interface{})
Panic(args ...interface{})
Log(level logrus.Level, args ...interface{})
Tracef(format string, args ...interface{})
Debugf(format string, args ...interface{})
Infof(format string, args ...interface{})
Warnf(format string, args ...interface{})
Warningf(format string, args ...interface{})
Errorf(format string, args ...interface{})
Fatalf(format string, args ...interface{})
Panicf(format string, args ...interface{})
Logf(level logrus.Level, format string, args ...interface{})
IsTracing() bool
IsDebugging() bool
IsInfo() bool
IsError() bool
IsWarn() bool
}
type logrusEntryWrapper struct {
e *logrus.Entry
}
func (l *logrusEntryWrapper) WithContext(ctx context.Context) Logger {
return addFromContext(
&logrusEntryWrapper{l.e.WithContext(ctx)},
ctx,
)
}
var durationType = reflect.TypeOf(time.Duration(0))
// splitDurationFields modifies fields to split every field of type
// time.Duration into 2 fields, one "_nsecs" and one "_str".
func (l *logrusEntryWrapper) WithFields(fields Fields) Logger {
var durationKeys []string
for key, value := range fields {
if value != nil && reflect.TypeOf(value).AssignableTo(durationType) {
durationKeys = append(durationKeys, key)
}
}
for _, key := range durationKeys {
duration := fields[key].(time.Duration)
fields[key] = duration.Nanoseconds()
fields[key+durationStr] = duration.String()
}
return &logrusEntryWrapper{l.e.WithFields(logrus.Fields(fields))}
}
func (l *logrusEntryWrapper) WithField(key string, value interface{}) Logger {
return l.WithFields(Fields{key: value})
}
func (l *logrusEntryWrapper) WithError(err error) Logger {
return &logrusEntryWrapper{l.e.WithError(err)}
}
func (l *logrusEntryWrapper) Trace(args ...interface{}) {
l.e.Trace(args...)
}
func (l *logrusEntryWrapper) Debug(args ...interface{}) {
l.e.Debug(args...)
}
func (l *logrusEntryWrapper) Info(args ...interface{}) {
l.e.Info(args...)
}
func (l *logrusEntryWrapper) Warn(args ...interface{}) {
l.e.Warn(args...)
}
func (l *logrusEntryWrapper) Warning(args ...interface{}) {
l.e.Warning(args...)
}
func (l *logrusEntryWrapper) Error(args ...interface{}) {
l.e.Error(args...)
}
func (l *logrusEntryWrapper) Fatal(args ...interface{}) {
l.e.Fatal(args...)
}
func (l *logrusEntryWrapper) Panic(args ...interface{}) {
l.e.Panic(args...)
}
func (l *logrusEntryWrapper) Log(level logrus.Level, args ...interface{}) {
l.e.Log(level, args...)
}
func (l *logrusEntryWrapper) Tracef(format string, args ...interface{}) {
l.e.Tracef(format, args...)
}
func (l *logrusEntryWrapper) Debugf(format string, args ...interface{}) {
l.e.Debugf(format, args...)
}
func (l *logrusEntryWrapper) Infof(format string, args ...interface{}) {
l.e.Infof(format, args...)
}
func (l *logrusEntryWrapper) Warnf(format string, args ...interface{}) {
l.e.Warnf(format, args...)
}
func (l *logrusEntryWrapper) Warningf(format string, args ...interface{}) {
l.e.Warningf(format, args...)
}
func (l *logrusEntryWrapper) Errorf(format string, args ...interface{}) {
l.e.Errorf(format, args...)
}
func (l *logrusEntryWrapper) Fatalf(format string, args ...interface{}) {
l.e.Fatalf(format, args...)
}
func (l *logrusEntryWrapper) Panicf(format string, args ...interface{}) {
l.e.Panicf(format, args...)
}
func (l *logrusEntryWrapper) Logf(level logrus.Level, format string, args ...interface{}) {
l.e.Logf(level, format, args...)
}
func (l *logrusEntryWrapper) IsTracing() bool {
return l.e.Logger.IsLevelEnabled(logrus.TraceLevel)
}
func (l *logrusEntryWrapper) IsDebugging() bool {
return l.e.Logger.IsLevelEnabled(logrus.DebugLevel)
}
func (l *logrusEntryWrapper) IsInfo() bool {
return l.e.Logger.IsLevelEnabled(logrus.InfoLevel)
}
func (l *logrusEntryWrapper) IsError() bool {
return l.e.Logger.IsLevelEnabled(logrus.ErrorLevel)
}
func (l *logrusEntryWrapper) IsWarn() bool {
return l.e.Logger.IsLevelEnabled(logrus.WarnLevel)
}
type logrusCallerFormatter struct {
f logrus.Formatter
}
func (lf logrusCallerFormatter) Format(e *logrus.Entry) ([]byte, error) {
e.Caller = getCaller()
return lf.f.Format(e)
}
// ContextUnavailable returns a Logger when no context is available. It
// should be used only in code during startup, teardown, or tests. Prefer
// to use Default().
func ContextUnavailable() Logger {
// wrap formatter with our own formatter that overrides caller
formatterInitOnce.Do(func() {
defaultLogger.SetReportCaller(true)
defaultLogger.SetNoLock()
defaultLogger.Formatter = logrusCallerFormatter{defaultLogger.Formatter}
})
return &logrusEntryWrapper{
e: logrus.NewEntry(defaultLogger),
}
}
// GetFieldsFromContext returns the logging fields on ctx or nil.
func GetFieldsFromContext(ctx context.Context) Fields {
fields := ctx.Value(LogFieldsContextKey)
if fields == nil {
return nil
}
return fields.(Fields)
}
func addFromContext(log Logger, ctx context.Context) Logger {
loggerFields := GetFieldsFromContext(ctx)
return log.WithFields(loggerFields)
}
// FromContext returns a Logger for reporting logs during ctx. This logger
// will typically include request IDs from the context.
func FromContext(ctx context.Context) Logger {
return addFromContext(ContextUnavailable(), ctx)
}
func AddFields(ctx context.Context, fields Fields) context.Context {
ctxFields := ctx.Value(LogFieldsContextKey)
loggerFields := Fields{}
if ctxFields != nil {
loggerFields = ctxFields.(Fields)
}
for k, v := range fields {
loggerFields[k] = v
}
return context.WithValue(ctx, LogFieldsContextKey, loggerFields)
}