blob: fe3a4e0fdfe6bd88c7f70734522c543a2fd31471 [file] [log] [blame]
khenaidoobf6e7bb2018-08-14 22:27:29 -04001/*
2 * Copyright 2018-present Open Networking Foundation
3
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7
8 * http://www.apache.org/licenses/LICENSE-2.0
9
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
khenaidoo7da372d2018-09-21 16:03:09 -040016
17//Package log provides a structured Logger interface implemented using zap logger. It provides the following capabilities:
18//1. Package level logging - a go package can register itself (AddPackage) and have a logger created for that package.
19//2. Dynamic log level change - for all registered packages (SetAllLogLevel)
20//3. Dynamic log level change - for a given package (SetPackageLogLevel)
21//4. Provides a default logger for unregistered packages
22//5. Allow key-value pairs to be added to a logger(UpdateLogger) or all loggers (UpdateAllLoggers) at run time
23//6. Add to the log output the location where the log was invoked (filename.functionname.linenumber)
24//
25// Using package-level logging (recommended approach). In the examples below, log refers to this log package.
26// 1. In the appropriate package add the following in the init section of the package. The log level can be changed
27// and any number of default fields can be added as well. The log level specifies the lowest log level that will be
28// in the output while the fields will be automatically added to all log printouts.
29//
30// log.AddPackage(mylog.JSON, log.WarnLevel, log.Fields{"anyFieldName": "any value"})
31//
32//2. In the calling package, just invoke any of the publicly available functions of the logger. Here is an example
33// to write an Info log with additional fields:
34//
35//log.Infow("An example", mylog.Fields{"myStringOutput": "output", "myIntOutput": 2})
36//
37//3. To dynamically change the log level, you can use 1)SetLogLevel from inside your package or 2) SetPackageLogLevel
38// from anywhere or 3) SetAllLogLevel from anywhere.
39//
40
khenaidoocfee5f42018-07-19 22:47:38 -040041package log
42
43import (
khenaidoo7da372d2018-09-21 16:03:09 -040044 "errors"
khenaidoo5c11af72018-07-20 17:21:05 -040045 "fmt"
khenaidoocfee5f42018-07-19 22:47:38 -040046 zp "go.uber.org/zap"
47 zc "go.uber.org/zap/zapcore"
khenaidoob9203542018-09-17 22:56:37 -040048 "path"
khenaidoocfee5f42018-07-19 22:47:38 -040049 "runtime"
50 "strings"
khenaidoocfee5f42018-07-19 22:47:38 -040051)
52
53const (
54 // DebugLevel logs a message at debug level
55 DebugLevel = iota
56 // InfoLevel logs a message at info level
57 InfoLevel
58 // WarnLevel logs a message at warning level
59 WarnLevel
60 // ErrorLevel logs a message at error level
61 ErrorLevel
62 // PanicLevel logs a message, then panics.
63 PanicLevel
64 // FatalLevel logs a message, then calls os.Exit(1).
65 FatalLevel
66)
67
68// CONSOLE formats the log for the console, mostly used during development
69const CONSOLE = "console"
khenaidoo5c11af72018-07-20 17:21:05 -040070
khenaidoocfee5f42018-07-19 22:47:38 -040071// JSON formats the log using json format, mostly used by an automated logging system consumption
72const JSON = "json"
73
74// Logger represents an abstract logging interface. Any logging implementation used
75// will need to abide by this interface
76type Logger interface {
77 Debug(...interface{})
78 Debugln(...interface{})
79 Debugf(string, ...interface{})
80 Debugw(string, Fields)
81
82 Info(...interface{})
83 Infoln(...interface{})
84 Infof(string, ...interface{})
85 Infow(string, Fields)
86
87 Warn(...interface{})
88 Warnln(...interface{})
89 Warnf(string, ...interface{})
90 Warnw(string, Fields)
91
92 Error(...interface{})
93 Errorln(...interface{})
94 Errorf(string, ...interface{})
95 Errorw(string, Fields)
96
97 Fatal(...interface{})
98 Fatalln(...interface{})
99 Fatalf(string, ...interface{})
100 Fatalw(string, Fields)
101
102 With(Fields) Logger
khenaidoo7da372d2018-09-21 16:03:09 -0400103
104 // The following are added to be able to use this logger as a gRPC LoggerV2 if needed
105 //
106 Warning(...interface{})
107 Warningln(...interface{})
108 Warningf(string, ...interface{})
109
110 // V reports whether verbosity level l is at least the requested verbose level.
111 V(l int) bool
khenaidoocfee5f42018-07-19 22:47:38 -0400112}
113
khenaidoo7da372d2018-09-21 16:03:09 -0400114// Fields is used as key-value pairs for structured logging
khenaidoocfee5f42018-07-19 22:47:38 -0400115type Fields map[string]interface{}
116
117var defaultLogger *logger
khenaidoob9203542018-09-17 22:56:37 -0400118var cfg zp.Config
119
120var loggers map[string]*logger
121var cfgs map[string]zp.Config
khenaidoocfee5f42018-07-19 22:47:38 -0400122
123type logger struct {
124 log *zp.SugaredLogger
125 parent *zp.Logger
126}
127
khenaidoo6f2fbe32019-01-18 16:16:50 -0500128func intToAtomicLevel(l int) zp.AtomicLevel {
khenaidoocfee5f42018-07-19 22:47:38 -0400129 switch l {
130 case DebugLevel:
131 return zp.NewAtomicLevelAt(zc.DebugLevel)
132 case InfoLevel:
133 return zp.NewAtomicLevelAt(zc.InfoLevel)
134 case WarnLevel:
135 return zp.NewAtomicLevelAt(zc.WarnLevel)
136 case ErrorLevel:
137 return zp.NewAtomicLevelAt(zc.ErrorLevel)
138 case PanicLevel:
139 return zp.NewAtomicLevelAt(zc.PanicLevel)
140 case FatalLevel:
141 return zp.NewAtomicLevelAt(zc.FatalLevel)
142 }
143 return zp.NewAtomicLevelAt(zc.ErrorLevel)
144}
145
khenaidoo6f2fbe32019-01-18 16:16:50 -0500146func intToLevel(l int) zc.Level {
khenaidoo7da372d2018-09-21 16:03:09 -0400147 switch l {
148 case DebugLevel:
149 return zc.DebugLevel
150 case InfoLevel:
khenaidoo6f2fbe32019-01-18 16:16:50 -0500151 return zc.InfoLevel
khenaidoo7da372d2018-09-21 16:03:09 -0400152 case WarnLevel:
153 return zc.WarnLevel
154 case ErrorLevel:
155 return zc.ErrorLevel
156 case PanicLevel:
157 return zc.PanicLevel
158 case FatalLevel:
159 return zc.FatalLevel
160 }
161 return zc.ErrorLevel
162}
163
khenaidoo6f2fbe32019-01-18 16:16:50 -0500164func levelToInt(l zc.Level) int {
165 switch l {
166 case zc.DebugLevel:
167 return DebugLevel
168 case zc.InfoLevel:
169 return InfoLevel
170 case zc.WarnLevel:
171 return WarnLevel
172 case zc.ErrorLevel:
173 return ErrorLevel
174 case zc.PanicLevel:
175 return PanicLevel
176 case FatalLevel:
177 return FatalLevel
178 }
179 return ErrorLevel
180}
181
khenaidoocfee5f42018-07-19 22:47:38 -0400182func getDefaultConfig(outputType string, level int, defaultFields Fields) zp.Config {
183 return zp.Config{
khenaidoo6f2fbe32019-01-18 16:16:50 -0500184 Level: intToAtomicLevel(level),
khenaidoocfee5f42018-07-19 22:47:38 -0400185 Encoding: outputType,
186 Development: true,
187 OutputPaths: []string{"stdout"},
188 ErrorOutputPaths: []string{"stderr"},
189 InitialFields: defaultFields,
190 EncoderConfig: zc.EncoderConfig{
191 LevelKey: "level",
192 MessageKey: "msg",
193 TimeKey: "ts",
194 StacktraceKey: "stacktrace",
195 LineEnding: zc.DefaultLineEnding,
196 EncodeLevel: zc.LowercaseLevelEncoder,
197 EncodeTime: zc.ISO8601TimeEncoder,
198 EncodeDuration: zc.SecondsDurationEncoder,
199 EncodeCaller: zc.ShortCallerEncoder,
200 },
201 }
202}
203
204// SetLogger needs to be invoked before the logger API can be invoked. This function
205// initialize the default logger (zap's sugaredlogger)
khenaidoob9203542018-09-17 22:56:37 -0400206func SetDefaultLogger(outputType string, level int, defaultFields Fields) (Logger, error) {
khenaidoocfee5f42018-07-19 22:47:38 -0400207 // Build a custom config using zap
khenaidood4d922e2018-08-03 22:35:16 -0400208 cfg = getDefaultConfig(outputType, level, defaultFields)
khenaidoocfee5f42018-07-19 22:47:38 -0400209
210 l, err := cfg.Build()
211 if err != nil {
212 return nil, err
213 }
214
215 defaultLogger = &logger{
216 log: l.Sugar(),
217 parent: l,
218 }
219
220 return defaultLogger, nil
221}
222
khenaidoo7da372d2018-09-21 16:03:09 -0400223// AddPackage registers a package to the log map. Each package gets its own logger which allows
224// its config (loglevel) to be changed dynamically without interacting with the other packages.
225// outputType is JSON, level is the lowest level log to output with this logger and defaultFields is a map of
226// key-value pairs to always add to the output.
227// Note: AddPackage also returns a reference to the actual logger. If a calling package uses this reference directly
228//instead of using the publicly available functions in this log package then a number of functionalities will not
229// be available to it, notably log tracing with filename.functionname.linenumber annotation.
230//
khenaidoo6f2fbe32019-01-18 16:16:50 -0500231// pkgNames parameter should be used for testing only as this function detects the caller's package.
232func AddPackage(outputType string, level int, defaultFields Fields, pkgNames ...string) (Logger, error) {
khenaidoob9203542018-09-17 22:56:37 -0400233 if cfgs == nil {
234 cfgs = make(map[string]zp.Config)
235 }
236 if loggers == nil {
237 loggers = make(map[string]*logger)
238 }
khenaidoo6f2fbe32019-01-18 16:16:50 -0500239
240 var pkgName string
241 for _, name := range pkgNames {
242 pkgName = name
243 break
244 }
245 if pkgName == "" {
246 pkgName, _, _, _ = getCallerInfo()
247 }
khenaidoob9203542018-09-17 22:56:37 -0400248
khenaidoo7da372d2018-09-21 16:03:09 -0400249 if _, exist := loggers[pkgName]; exist {
250 return loggers[pkgName], nil
khenaidoob9203542018-09-17 22:56:37 -0400251 }
khenaidoo7da372d2018-09-21 16:03:09 -0400252
khenaidoob9203542018-09-17 22:56:37 -0400253 cfgs[pkgName] = getDefaultConfig(outputType, level, defaultFields)
254
255 l, err := cfgs[pkgName].Build()
256 if err != nil {
khenaidoo7da372d2018-09-21 16:03:09 -0400257 return nil, err
khenaidoob9203542018-09-17 22:56:37 -0400258 }
259
260 loggers[pkgName] = &logger{
261 log: l.Sugar(),
262 parent: l,
263 }
khenaidoo7da372d2018-09-21 16:03:09 -0400264 return loggers[pkgName], nil
khenaidoob9203542018-09-17 22:56:37 -0400265}
266
khenaidoo7da372d2018-09-21 16:03:09 -0400267//UpdateAllLoggers create new loggers for all registered pacakges with the defaultFields.
khenaidoob9203542018-09-17 22:56:37 -0400268func UpdateAllLoggers(defaultFields Fields) error {
269 for pkgName, cfg := range cfgs {
270 for k, v := range defaultFields {
271 if cfg.InitialFields == nil {
272 cfg.InitialFields = make(map[string]interface{})
273 }
274 cfg.InitialFields[k] = v
275 }
276 l, err := cfg.Build()
277 if err != nil {
278 return err
279 }
280
281 loggers[pkgName] = &logger{
282 log: l.Sugar(),
283 parent: l,
284 }
285 }
286 return nil
287}
288
Scott Baker112b0d42019-08-22 08:32:26 -0700289// Return a list of all packages that have individually-configured loggers
290func GetPackageNames() []string {
291 i := 0
292 keys := make([]string, len(loggers))
293 for k := range loggers {
294 keys[i] = k
295 i++
296 }
297 return keys
298}
299
khenaidoo7da372d2018-09-21 16:03:09 -0400300// UpdateLogger deletes the logger associated with a caller's package and creates a new logger with the
301// defaultFields. If a calling package is holding on to a Logger reference obtained from AddPackage invocation, then
302// that package needs to invoke UpdateLogger if it needs to make changes to the default fields and obtain a new logger
303// reference
304func UpdateLogger(defaultFields Fields) (Logger, error) {
305 pkgName, _, _, _ := getCallerInfo()
306 if _, exist := loggers[pkgName]; !exist {
307 return nil, errors.New(fmt.Sprintf("package-%s-not-registered", pkgName))
308 }
khenaidoob9203542018-09-17 22:56:37 -0400309
khenaidoo7da372d2018-09-21 16:03:09 -0400310 // Build a new logger
311 if _, exist := cfgs[pkgName]; !exist {
312 return nil, errors.New(fmt.Sprintf("config-%s-not-registered", pkgName))
313 }
314
315 cfg := cfgs[pkgName]
316 for k, v := range defaultFields {
317 if cfg.InitialFields == nil {
318 cfg.InitialFields = make(map[string]interface{})
319 }
320 cfg.InitialFields[k] = v
321 }
322 l, err := cfg.Build()
323 if err != nil {
324 return nil, err
325 }
326
327 // Set the logger
328 loggers[pkgName] = &logger{
329 log: l.Sugar(),
330 parent: l,
331 }
332 return loggers[pkgName], nil
333}
334
khenaidoo6f2fbe32019-01-18 16:16:50 -0500335func setLevel(cfg zp.Config, level int) {
khenaidoo7da372d2018-09-21 16:03:09 -0400336 switch level {
337 case DebugLevel:
338 cfg.Level.SetLevel(zc.DebugLevel)
339 case InfoLevel:
340 cfg.Level.SetLevel(zc.InfoLevel)
341 case WarnLevel:
342 cfg.Level.SetLevel(zc.WarnLevel)
343 case ErrorLevel:
344 cfg.Level.SetLevel(zc.ErrorLevel)
345 case PanicLevel:
346 cfg.Level.SetLevel(zc.PanicLevel)
347 case FatalLevel:
348 cfg.Level.SetLevel(zc.FatalLevel)
349 default:
350 cfg.Level.SetLevel(zc.ErrorLevel)
351 }
khenaidoo6f2fbe32019-01-18 16:16:50 -0500352}
353
354//SetPackageLogLevel dynamically sets the log level of a given package to level. This is typically invoked at an
355// application level during debugging
356func SetPackageLogLevel(packageName string, level int) {
357 // Get proper config
358 if cfg, ok := cfgs[packageName]; ok {
359 setLevel(cfg, level)
360 }
361}
362
363//SetAllLogLevel sets the log level of all registered packages to level
364func SetAllLogLevel(level int) {
365 // Get proper config
366 for _, cfg := range cfgs {
367 setLevel(cfg, level)
368 }
369}
370
371//GetPackageLogLevel returns the current log level of a package.
khenaidoo910204f2019-04-08 17:56:40 -0400372func GetPackageLogLevel(packageName ...string) (int, error) {
373 var name string
374 if len(packageName) == 1 {
375 name = packageName[0]
376 } else {
377 name, _, _, _ = getCallerInfo()
378 }
379 if cfg, ok := cfgs[name]; ok {
khenaidoo6f2fbe32019-01-18 16:16:50 -0500380 return levelToInt(cfg.Level.Level()), nil
381 }
khenaidoo910204f2019-04-08 17:56:40 -0400382 return 0, errors.New(fmt.Sprintf("unknown-package-%s", name))
khenaidoo6f2fbe32019-01-18 16:16:50 -0500383}
384
Scott Baker112b0d42019-08-22 08:32:26 -0700385//GetDefaultLogLevel gets the log level used for packages that don't have specific loggers
386func GetDefaultLogLevel() int {
387 return levelToInt(cfg.Level.Level())
388}
389
khenaidoo6f2fbe32019-01-18 16:16:50 -0500390//SetLogLevel sets the log level for the logger corresponding to the caller's package
391func SetLogLevel(level int) error {
392 pkgName, _, _, _ := getCallerInfo()
393 if _, exist := cfgs[pkgName]; !exist {
394 return errors.New(fmt.Sprintf("unregistered-package-%s", pkgName))
395 }
396 cfg := cfgs[pkgName]
397 setLevel(cfg, level)
khenaidoo7da372d2018-09-21 16:03:09 -0400398 return nil
399}
400
Scott Baker112b0d42019-08-22 08:32:26 -0700401//SetDefaultLogLevel sets the log level used for packages that don't have specific loggers
402func SetDefaultLogLevel(level int) {
403 setLevel(cfg, level)
404}
405
khenaidoocfee5f42018-07-19 22:47:38 -0400406// CleanUp flushed any buffered log entries. Applications should take care to call
407// CleanUp before exiting.
408func CleanUp() error {
khenaidoob9203542018-09-17 22:56:37 -0400409 for _, logger := range loggers {
410 if logger != nil {
411 if logger.parent != nil {
412 if err := logger.parent.Sync(); err != nil {
413 return err
414 }
415 }
416 }
417 }
khenaidoocfee5f42018-07-19 22:47:38 -0400418 if defaultLogger != nil {
419 if defaultLogger.parent != nil {
420 if err := defaultLogger.parent.Sync(); err != nil {
421 return err
422 }
423 }
424 }
425 return nil
426}
427
khenaidoo7da372d2018-09-21 16:03:09 -0400428func getCallerInfo() (string, string, string, int) {
khenaidoo2c6f1672018-09-20 23:14:41 -0400429 // Since the caller of a log function is one stack frame before (in terms of stack higher level) the log.go
430 // filename, then first look for the last log.go filename and then grab the caller info one level higher.
431 maxLevel := 3
khenaidoo7da372d2018-09-21 16:03:09 -0400432 skiplevel := 3 // Level with the most empirical success to see the last log.go stack frame.
khenaidoo2c6f1672018-09-20 23:14:41 -0400433 pc := make([]uintptr, maxLevel)
434 n := runtime.Callers(skiplevel, pc)
khenaidoob9203542018-09-17 22:56:37 -0400435 packageName := ""
khenaidoo2c6f1672018-09-20 23:14:41 -0400436 funcName := ""
437 fileName := ""
438 var line int
439 if n == 0 {
440 return packageName, fileName, funcName, line
441 }
442 frames := runtime.CallersFrames(pc[:n])
443 var frame runtime.Frame
444 var foundFrame runtime.Frame
445 more := true
446 for more {
447 frame, more = frames.Next()
448 _, fileName = path.Split(frame.File)
449 if fileName != "log.go" {
450 foundFrame = frame // First frame after log.go in the frame stack
451 break
452 }
453 }
454 parts := strings.Split(foundFrame.Function, ".")
455 pl := len(parts)
456 if pl >= 2 {
457 funcName = parts[pl-1]
458 if parts[pl-2][0] == '(' {
459 packageName = strings.Join(parts[0:pl-2], ".")
460 } else {
461 packageName = strings.Join(parts[0:pl-1], ".")
462 }
khenaidoocfee5f42018-07-19 22:47:38 -0400463 }
464
khenaidoo2c6f1672018-09-20 23:14:41 -0400465 if strings.HasSuffix(packageName, ".init") {
khenaidoo7da372d2018-09-21 16:03:09 -0400466 packageName = strings.TrimSuffix(packageName, ".init")
khenaidoob9203542018-09-17 22:56:37 -0400467 }
468
469 if strings.HasSuffix(fileName, ".go") {
khenaidoo7da372d2018-09-21 16:03:09 -0400470 fileName = strings.TrimSuffix(fileName, ".go")
khenaidoob9203542018-09-17 22:56:37 -0400471 }
khenaidoo2c6f1672018-09-20 23:14:41 -0400472
473 return packageName, fileName, funcName, foundFrame.Line
khenaidoob9203542018-09-17 22:56:37 -0400474}
475
khenaidoo7da372d2018-09-21 16:03:09 -0400476func getPackageLevelSugaredLogger() *zp.SugaredLogger {
khenaidoob9203542018-09-17 22:56:37 -0400477 pkgName, fileName, funcName, line := getCallerInfo()
478 if _, exist := loggers[pkgName]; exist {
479 return loggers[pkgName].log.With("caller", fmt.Sprintf("%s.%s:%d", fileName, funcName, line))
480 }
481 return defaultLogger.log.With("caller", fmt.Sprintf("%s.%s:%d", fileName, funcName, line))
482}
khenaidoocfee5f42018-07-19 22:47:38 -0400483
khenaidoo7da372d2018-09-21 16:03:09 -0400484func getPackageLevelLogger() Logger {
485 pkgName, _, _, _ := getCallerInfo()
486 if _, exist := loggers[pkgName]; exist {
487 return loggers[pkgName]
488 }
489 return defaultLogger
490}
491
khenaidoocfee5f42018-07-19 22:47:38 -0400492func serializeMap(fields Fields) []interface{} {
493 data := make([]interface{}, len(fields)*2)
494 i := 0
495 for k, v := range fields {
496 data[i] = k
497 data[i+1] = v
498 i = i + 2
499 }
500 return data
501}
502
503// With returns a logger initialized with the key-value pairs
504func (l logger) With(keysAndValues Fields) Logger {
505 return logger{log: l.log.With(serializeMap(keysAndValues)...), parent: l.parent}
506}
507
508// Debug logs a message at level Debug on the standard logger.
509func (l logger) Debug(args ...interface{}) {
510 l.log.Debug(args...)
511}
512
513// Debugln logs a message at level Debug on the standard logger with a line feed. Default in any case.
514func (l logger) Debugln(args ...interface{}) {
515 l.log.Debug(args...)
516}
517
518// Debugw logs a message at level Debug on the standard logger.
519func (l logger) Debugf(format string, args ...interface{}) {
520 l.log.Debugf(format, args...)
521}
522
523// Debugw logs a message with some additional context. The variadic key-value
524// pairs are treated as they are in With.
525func (l logger) Debugw(msg string, keysAndValues Fields) {
526 l.log.Debugw(msg, serializeMap(keysAndValues)...)
527}
528
529// Info logs a message at level Info on the standard logger.
530func (l logger) Info(args ...interface{}) {
531 l.log.Info(args...)
532}
533
534// Infoln logs a message at level Info on the standard logger with a line feed. Default in any case.
535func (l logger) Infoln(args ...interface{}) {
536 l.log.Info(args...)
537 //msg := fmt.Sprintln(args...)
538 //l.sourced().Info(msg[:len(msg)-1])
539}
540
541// Infof logs a message at level Info on the standard logger.
542func (l logger) Infof(format string, args ...interface{}) {
543 l.log.Infof(format, args...)
544}
545
546// Infow logs a message with some additional context. The variadic key-value
547// pairs are treated as they are in With.
548func (l logger) Infow(msg string, keysAndValues Fields) {
549 l.log.Infow(msg, serializeMap(keysAndValues)...)
550}
551
552// Warn logs a message at level Warn on the standard logger.
553func (l logger) Warn(args ...interface{}) {
554 l.log.Warn(args...)
555}
556
557// Warnln logs a message at level Warn on the standard logger with a line feed. Default in any case.
558func (l logger) Warnln(args ...interface{}) {
559 l.log.Warn(args...)
560}
561
562// Warnf logs a message at level Warn on the standard logger.
563func (l logger) Warnf(format string, args ...interface{}) {
564 l.log.Warnf(format, args...)
565}
566
567// Warnw logs a message with some additional context. The variadic key-value
568// pairs are treated as they are in With.
569func (l logger) Warnw(msg string, keysAndValues Fields) {
570 l.log.Warnw(msg, serializeMap(keysAndValues)...)
571}
572
573// Error logs a message at level Error on the standard logger.
574func (l logger) Error(args ...interface{}) {
575 l.log.Error(args...)
576}
577
578// Errorln logs a message at level Error on the standard logger with a line feed. Default in any case.
579func (l logger) Errorln(args ...interface{}) {
580 l.log.Error(args...)
581}
582
583// Errorf logs a message at level Error on the standard logger.
584func (l logger) Errorf(format string, args ...interface{}) {
585 l.log.Errorf(format, args...)
586}
587
588// Errorw logs a message with some additional context. The variadic key-value
589// pairs are treated as they are in With.
590func (l logger) Errorw(msg string, keysAndValues Fields) {
591 l.log.Errorw(msg, serializeMap(keysAndValues)...)
592}
593
594// Fatal logs a message at level Fatal on the standard logger.
595func (l logger) Fatal(args ...interface{}) {
596 l.log.Fatal(args...)
597}
598
599// Fatalln logs a message at level Fatal on the standard logger with a line feed. Default in any case.
600func (l logger) Fatalln(args ...interface{}) {
601 l.log.Fatal(args...)
602}
603
604// Fatalf logs a message at level Fatal on the standard logger.
605func (l logger) Fatalf(format string, args ...interface{}) {
606 l.log.Fatalf(format, args...)
607}
608
609// Fatalw logs a message with some additional context. The variadic key-value
610// pairs are treated as they are in With.
611func (l logger) Fatalw(msg string, keysAndValues Fields) {
612 l.log.Fatalw(msg, serializeMap(keysAndValues)...)
613}
614
khenaidoo7da372d2018-09-21 16:03:09 -0400615// Warning logs a message at level Warn on the standard logger.
616func (l logger) Warning(args ...interface{}) {
617 l.log.Warn(args...)
618}
619
620// Warningln logs a message at level Warn on the standard logger with a line feed. Default in any case.
621func (l logger) Warningln(args ...interface{}) {
622 l.log.Warn(args...)
623}
624
625// Warningf logs a message at level Warn on the standard logger.
626func (l logger) Warningf(format string, args ...interface{}) {
627 l.log.Warnf(format, args...)
628}
629
630// V reports whether verbosity level l is at least the requested verbose level.
631func (l logger) V(level int) bool {
khenaidoo6f2fbe32019-01-18 16:16:50 -0500632 return l.parent.Core().Enabled(intToLevel(level))
khenaidoo7da372d2018-09-21 16:03:09 -0400633}
634
khenaidoocfee5f42018-07-19 22:47:38 -0400635// With returns a logger initialized with the key-value pairs
636func With(keysAndValues Fields) Logger {
khenaidoo7da372d2018-09-21 16:03:09 -0400637 return logger{log: getPackageLevelSugaredLogger().With(serializeMap(keysAndValues)...), parent: defaultLogger.parent}
khenaidoocfee5f42018-07-19 22:47:38 -0400638}
639
640// Debug logs a message at level Debug on the standard logger.
641func Debug(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400642 getPackageLevelSugaredLogger().Debug(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400643}
644
645// Debugln logs a message at level Debug on the standard logger.
646func Debugln(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400647 getPackageLevelSugaredLogger().Debug(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400648}
649
650// Debugf logs a message at level Debug on the standard logger.
651func Debugf(format string, args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400652 getPackageLevelSugaredLogger().Debugf(format, args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400653}
654
655// Debugw logs a message with some additional context. The variadic key-value
656// pairs are treated as they are in With.
657func Debugw(msg string, keysAndValues Fields) {
khenaidoo7da372d2018-09-21 16:03:09 -0400658 getPackageLevelSugaredLogger().Debugw(msg, serializeMap(keysAndValues)...)
khenaidoocfee5f42018-07-19 22:47:38 -0400659}
660
661// Info logs a message at level Info on the standard logger.
662func Info(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400663 getPackageLevelSugaredLogger().Info(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400664}
665
666// Infoln logs a message at level Info on the standard logger.
667func Infoln(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400668 getPackageLevelSugaredLogger().Info(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400669}
670
671// Infof logs a message at level Info on the standard logger.
672func Infof(format string, args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400673 getPackageLevelSugaredLogger().Infof(format, args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400674}
675
676//Infow logs a message with some additional context. The variadic key-value
677//pairs are treated as they are in With.
678func Infow(msg string, keysAndValues Fields) {
khenaidoo7da372d2018-09-21 16:03:09 -0400679 getPackageLevelSugaredLogger().Infow(msg, serializeMap(keysAndValues)...)
khenaidoocfee5f42018-07-19 22:47:38 -0400680}
681
682// Warn logs a message at level Warn on the standard logger.
683func Warn(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400684 getPackageLevelSugaredLogger().Warn(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400685}
686
687// Warnln logs a message at level Warn on the standard logger.
688func Warnln(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400689 getPackageLevelSugaredLogger().Warn(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400690}
691
692// Warnf logs a message at level Warn on the standard logger.
693func Warnf(format string, args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400694 getPackageLevelSugaredLogger().Warnf(format, args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400695}
696
697// Warnw logs a message with some additional context. The variadic key-value
698// pairs are treated as they are in With.
699func Warnw(msg string, keysAndValues Fields) {
khenaidoo7da372d2018-09-21 16:03:09 -0400700 getPackageLevelSugaredLogger().Warnw(msg, serializeMap(keysAndValues)...)
khenaidoocfee5f42018-07-19 22:47:38 -0400701}
702
703// Error logs a message at level Error on the standard logger.
704func Error(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400705 getPackageLevelSugaredLogger().Error(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400706}
707
708// Errorln logs a message at level Error on the standard logger.
709func Errorln(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400710 getPackageLevelSugaredLogger().Error(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400711}
712
713// Errorf logs a message at level Error on the standard logger.
714func Errorf(format string, args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400715 getPackageLevelSugaredLogger().Errorf(format, args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400716}
717
718// Errorw logs a message with some additional context. The variadic key-value
719// pairs are treated as they are in With.
720func Errorw(msg string, keysAndValues Fields) {
khenaidoo7da372d2018-09-21 16:03:09 -0400721 getPackageLevelSugaredLogger().Errorw(msg, serializeMap(keysAndValues)...)
khenaidoocfee5f42018-07-19 22:47:38 -0400722}
723
724// Fatal logs a message at level Fatal on the standard logger.
725func Fatal(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400726 getPackageLevelSugaredLogger().Fatal(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400727}
728
729// Fatalln logs a message at level Fatal on the standard logger.
730func Fatalln(args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400731 getPackageLevelSugaredLogger().Fatal(args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400732}
733
734// Fatalf logs a message at level Fatal on the standard logger.
735func Fatalf(format string, args ...interface{}) {
khenaidoo7da372d2018-09-21 16:03:09 -0400736 getPackageLevelSugaredLogger().Fatalf(format, args...)
khenaidoocfee5f42018-07-19 22:47:38 -0400737}
738
739// Fatalw logs a message with some additional context. The variadic key-value
740// pairs are treated as they are in With.
741func Fatalw(msg string, keysAndValues Fields) {
khenaidoo7da372d2018-09-21 16:03:09 -0400742 getPackageLevelSugaredLogger().Fatalw(msg, serializeMap(keysAndValues)...)
743}
744
745// Warning logs a message at level Warn on the standard logger.
746func Warning(args ...interface{}) {
747 getPackageLevelSugaredLogger().Warn(args...)
748}
749
750// Warningln logs a message at level Warn on the standard logger.
751func Warningln(args ...interface{}) {
752 getPackageLevelSugaredLogger().Warn(args...)
753}
754
755// Warningf logs a message at level Warn on the standard logger.
756func Warningf(format string, args ...interface{}) {
757 getPackageLevelSugaredLogger().Warnf(format, args...)
758}
759
760// V reports whether verbosity level l is at least the requested verbose level.
761func V(level int) bool {
762 return getPackageLevelLogger().V(level)
khenaidoocfee5f42018-07-19 22:47:38 -0400763}