khenaidoo | bf6e7bb | 2018-08-14 22:27:29 -0400 | [diff] [blame^] | 1 | /* |
| 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 | */ |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 16 | package log |
| 17 | |
| 18 | import ( |
khenaidoo | 5c11af7 | 2018-07-20 17:21:05 -0400 | [diff] [blame] | 19 | "fmt" |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 20 | zp "go.uber.org/zap" |
| 21 | zc "go.uber.org/zap/zapcore" |
| 22 | "runtime" |
| 23 | "strings" |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 24 | ) |
| 25 | |
| 26 | const ( |
| 27 | // DebugLevel logs a message at debug level |
| 28 | DebugLevel = iota |
| 29 | // InfoLevel logs a message at info level |
| 30 | InfoLevel |
| 31 | // WarnLevel logs a message at warning level |
| 32 | WarnLevel |
| 33 | // ErrorLevel logs a message at error level |
| 34 | ErrorLevel |
| 35 | // PanicLevel logs a message, then panics. |
| 36 | PanicLevel |
| 37 | // FatalLevel logs a message, then calls os.Exit(1). |
| 38 | FatalLevel |
| 39 | ) |
| 40 | |
| 41 | // CONSOLE formats the log for the console, mostly used during development |
| 42 | const CONSOLE = "console" |
khenaidoo | 5c11af7 | 2018-07-20 17:21:05 -0400 | [diff] [blame] | 43 | |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 44 | // JSON formats the log using json format, mostly used by an automated logging system consumption |
| 45 | const JSON = "json" |
| 46 | |
| 47 | // Logger represents an abstract logging interface. Any logging implementation used |
| 48 | // will need to abide by this interface |
| 49 | type Logger interface { |
| 50 | Debug(...interface{}) |
| 51 | Debugln(...interface{}) |
| 52 | Debugf(string, ...interface{}) |
| 53 | Debugw(string, Fields) |
| 54 | |
| 55 | Info(...interface{}) |
| 56 | Infoln(...interface{}) |
| 57 | Infof(string, ...interface{}) |
| 58 | Infow(string, Fields) |
| 59 | |
| 60 | Warn(...interface{}) |
| 61 | Warnln(...interface{}) |
| 62 | Warnf(string, ...interface{}) |
| 63 | Warnw(string, Fields) |
| 64 | |
| 65 | Error(...interface{}) |
| 66 | Errorln(...interface{}) |
| 67 | Errorf(string, ...interface{}) |
| 68 | Errorw(string, Fields) |
| 69 | |
| 70 | Fatal(...interface{}) |
| 71 | Fatalln(...interface{}) |
| 72 | Fatalf(string, ...interface{}) |
| 73 | Fatalw(string, Fields) |
| 74 | |
| 75 | With(Fields) Logger |
| 76 | } |
| 77 | |
| 78 | // Fields is used as key-value pairs for structural logging |
| 79 | type Fields map[string]interface{} |
| 80 | |
| 81 | var defaultLogger *logger |
| 82 | |
| 83 | type logger struct { |
| 84 | log *zp.SugaredLogger |
| 85 | parent *zp.Logger |
| 86 | } |
| 87 | |
| 88 | func parseLevel(l int) zp.AtomicLevel { |
| 89 | switch l { |
| 90 | case DebugLevel: |
| 91 | return zp.NewAtomicLevelAt(zc.DebugLevel) |
| 92 | case InfoLevel: |
| 93 | return zp.NewAtomicLevelAt(zc.InfoLevel) |
| 94 | case WarnLevel: |
| 95 | return zp.NewAtomicLevelAt(zc.WarnLevel) |
| 96 | case ErrorLevel: |
| 97 | return zp.NewAtomicLevelAt(zc.ErrorLevel) |
| 98 | case PanicLevel: |
| 99 | return zp.NewAtomicLevelAt(zc.PanicLevel) |
| 100 | case FatalLevel: |
| 101 | return zp.NewAtomicLevelAt(zc.FatalLevel) |
| 102 | } |
| 103 | return zp.NewAtomicLevelAt(zc.ErrorLevel) |
| 104 | } |
| 105 | |
| 106 | func getDefaultConfig(outputType string, level int, defaultFields Fields) zp.Config { |
| 107 | return zp.Config{ |
| 108 | Level: parseLevel(level), |
| 109 | Encoding: outputType, |
| 110 | Development: true, |
| 111 | OutputPaths: []string{"stdout"}, |
| 112 | ErrorOutputPaths: []string{"stderr"}, |
| 113 | InitialFields: defaultFields, |
| 114 | EncoderConfig: zc.EncoderConfig{ |
| 115 | LevelKey: "level", |
| 116 | MessageKey: "msg", |
| 117 | TimeKey: "ts", |
| 118 | StacktraceKey: "stacktrace", |
| 119 | LineEnding: zc.DefaultLineEnding, |
| 120 | EncodeLevel: zc.LowercaseLevelEncoder, |
| 121 | EncodeTime: zc.ISO8601TimeEncoder, |
| 122 | EncodeDuration: zc.SecondsDurationEncoder, |
| 123 | EncodeCaller: zc.ShortCallerEncoder, |
| 124 | }, |
| 125 | } |
| 126 | } |
| 127 | |
khenaidoo | d4d922e | 2018-08-03 22:35:16 -0400 | [diff] [blame] | 128 | var cfg zp.Config |
| 129 | |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 130 | // SetLogger needs to be invoked before the logger API can be invoked. This function |
| 131 | // initialize the default logger (zap's sugaredlogger) |
| 132 | func SetLogger(outputType string, level int, defaultFields Fields) (Logger, error) { |
| 133 | |
| 134 | // Build a custom config using zap |
khenaidoo | d4d922e | 2018-08-03 22:35:16 -0400 | [diff] [blame] | 135 | cfg = getDefaultConfig(outputType, level, defaultFields) |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 136 | |
| 137 | l, err := cfg.Build() |
| 138 | if err != nil { |
| 139 | return nil, err |
| 140 | } |
| 141 | |
| 142 | defaultLogger = &logger{ |
| 143 | log: l.Sugar(), |
| 144 | parent: l, |
| 145 | } |
| 146 | |
| 147 | return defaultLogger, nil |
| 148 | } |
| 149 | |
khenaidoo | d4d922e | 2018-08-03 22:35:16 -0400 | [diff] [blame] | 150 | func SetLoglevel(level int) { |
| 151 | switch level { |
| 152 | case DebugLevel: |
| 153 | cfg.Level.SetLevel(zc.DebugLevel) |
| 154 | case InfoLevel: |
| 155 | cfg.Level.SetLevel(zc.InfoLevel) |
| 156 | case WarnLevel: |
| 157 | cfg.Level.SetLevel(zc.WarnLevel) |
| 158 | case ErrorLevel: |
| 159 | cfg.Level.SetLevel(zc.ErrorLevel) |
| 160 | case PanicLevel: |
| 161 | cfg.Level.SetLevel(zc.PanicLevel) |
| 162 | case FatalLevel: |
| 163 | cfg.Level.SetLevel(zc.FatalLevel) |
| 164 | default: |
| 165 | cfg.Level.SetLevel(zc.ErrorLevel) |
| 166 | } |
| 167 | } |
| 168 | |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 169 | // CleanUp flushed any buffered log entries. Applications should take care to call |
| 170 | // CleanUp before exiting. |
| 171 | func CleanUp() error { |
| 172 | if defaultLogger != nil { |
| 173 | if defaultLogger.parent != nil { |
| 174 | if err := defaultLogger.parent.Sync(); err != nil { |
| 175 | return err |
| 176 | } |
| 177 | } |
| 178 | } |
| 179 | return nil |
| 180 | } |
| 181 | |
| 182 | // GetLogger returned the default logger. If SetLogger was not previously invoked then |
| 183 | // this method will return an error |
| 184 | func GetLogger() (Logger, error) { |
| 185 | if defaultLogger == nil { |
khenaidoo | abad44c | 2018-08-03 16:58:35 -0400 | [diff] [blame] | 186 | // Setup the logger with default values - debug level, |
| 187 | SetLogger(JSON, 0, Fields{"instanceId": "default-logger"}) |
| 188 | //return nil, errors.New("Uninitialized-logger") |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 189 | } |
| 190 | return defaultLogger, nil |
| 191 | } |
| 192 | |
| 193 | func extractFileNameAndLineNumber(skipLevel int) (string, int) { |
| 194 | _, file, line, ok := runtime.Caller(skipLevel) |
| 195 | var key string |
| 196 | if !ok { |
| 197 | key = "<???>" |
| 198 | line = 1 |
| 199 | } else { |
| 200 | slash := strings.LastIndex(file, "/") |
| 201 | key = file[slash+1:] |
| 202 | } |
| 203 | return key, line |
| 204 | } |
| 205 | |
| 206 | // sourced adds a source field to the logger that contains |
| 207 | // the file name and line where the logging happened. |
| 208 | func (l *logger) sourced() *zp.SugaredLogger { |
| 209 | key, line := extractFileNameAndLineNumber(3) |
| 210 | if strings.HasSuffix(key, "log.go") || strings.HasSuffix(key, "proc.go") { |
| 211 | // Go to a lower level |
| 212 | key, line = extractFileNameAndLineNumber(2) |
| 213 | } |
| 214 | if !strings.HasSuffix(key, ".go") { |
| 215 | // Go to a higher level |
| 216 | key, line = extractFileNameAndLineNumber(4) |
| 217 | } |
| 218 | |
| 219 | return l.log.With("caller", fmt.Sprintf("%s:%d", key, line)) |
| 220 | } |
| 221 | |
| 222 | //func serializeMap(fields Fields) []interface{} { |
| 223 | // data := make([]interface{}, len(fields)*2+2) |
| 224 | // i := 0 |
| 225 | // for k, v := range fields { |
| 226 | // data[i] = k |
| 227 | // data[i+1] = v |
| 228 | // i = i + 2 |
| 229 | // } |
| 230 | // key, line := extractFileNameAndLineNumber(3) |
| 231 | // data[i] = "caller" |
| 232 | // data[i+1] = fmt.Sprintf("%s:%d", key, line) |
| 233 | // |
| 234 | // return data |
| 235 | //} |
| 236 | |
| 237 | func serializeMap(fields Fields) []interface{} { |
| 238 | data := make([]interface{}, len(fields)*2) |
| 239 | i := 0 |
| 240 | for k, v := range fields { |
| 241 | data[i] = k |
| 242 | data[i+1] = v |
| 243 | i = i + 2 |
| 244 | } |
| 245 | return data |
| 246 | } |
| 247 | |
| 248 | // With returns a logger initialized with the key-value pairs |
| 249 | func (l logger) With(keysAndValues Fields) Logger { |
| 250 | return logger{log: l.log.With(serializeMap(keysAndValues)...), parent: l.parent} |
| 251 | } |
| 252 | |
| 253 | // Debug logs a message at level Debug on the standard logger. |
| 254 | func (l logger) Debug(args ...interface{}) { |
| 255 | l.log.Debug(args...) |
| 256 | } |
| 257 | |
| 258 | // Debugln logs a message at level Debug on the standard logger with a line feed. Default in any case. |
| 259 | func (l logger) Debugln(args ...interface{}) { |
| 260 | l.log.Debug(args...) |
| 261 | } |
| 262 | |
| 263 | // Debugw logs a message at level Debug on the standard logger. |
| 264 | func (l logger) Debugf(format string, args ...interface{}) { |
| 265 | l.log.Debugf(format, args...) |
| 266 | } |
| 267 | |
| 268 | // Debugw logs a message with some additional context. The variadic key-value |
| 269 | // pairs are treated as they are in With. |
| 270 | func (l logger) Debugw(msg string, keysAndValues Fields) { |
| 271 | l.log.Debugw(msg, serializeMap(keysAndValues)...) |
| 272 | } |
| 273 | |
| 274 | // Info logs a message at level Info on the standard logger. |
| 275 | func (l logger) Info(args ...interface{}) { |
| 276 | l.log.Info(args...) |
| 277 | } |
| 278 | |
| 279 | // Infoln logs a message at level Info on the standard logger with a line feed. Default in any case. |
| 280 | func (l logger) Infoln(args ...interface{}) { |
| 281 | l.log.Info(args...) |
| 282 | //msg := fmt.Sprintln(args...) |
| 283 | //l.sourced().Info(msg[:len(msg)-1]) |
| 284 | } |
| 285 | |
| 286 | // Infof logs a message at level Info on the standard logger. |
| 287 | func (l logger) Infof(format string, args ...interface{}) { |
| 288 | l.log.Infof(format, args...) |
| 289 | } |
| 290 | |
| 291 | // Infow logs a message with some additional context. The variadic key-value |
| 292 | // pairs are treated as they are in With. |
| 293 | func (l logger) Infow(msg string, keysAndValues Fields) { |
| 294 | l.log.Infow(msg, serializeMap(keysAndValues)...) |
| 295 | } |
| 296 | |
| 297 | // Warn logs a message at level Warn on the standard logger. |
| 298 | func (l logger) Warn(args ...interface{}) { |
| 299 | l.log.Warn(args...) |
| 300 | } |
| 301 | |
| 302 | // Warnln logs a message at level Warn on the standard logger with a line feed. Default in any case. |
| 303 | func (l logger) Warnln(args ...interface{}) { |
| 304 | l.log.Warn(args...) |
| 305 | } |
| 306 | |
| 307 | // Warnf logs a message at level Warn on the standard logger. |
| 308 | func (l logger) Warnf(format string, args ...interface{}) { |
| 309 | l.log.Warnf(format, args...) |
| 310 | } |
| 311 | |
| 312 | // Warnw logs a message with some additional context. The variadic key-value |
| 313 | // pairs are treated as they are in With. |
| 314 | func (l logger) Warnw(msg string, keysAndValues Fields) { |
| 315 | l.log.Warnw(msg, serializeMap(keysAndValues)...) |
| 316 | } |
| 317 | |
| 318 | // Error logs a message at level Error on the standard logger. |
| 319 | func (l logger) Error(args ...interface{}) { |
| 320 | l.log.Error(args...) |
| 321 | } |
| 322 | |
| 323 | // Errorln logs a message at level Error on the standard logger with a line feed. Default in any case. |
| 324 | func (l logger) Errorln(args ...interface{}) { |
| 325 | l.log.Error(args...) |
| 326 | } |
| 327 | |
| 328 | // Errorf logs a message at level Error on the standard logger. |
| 329 | func (l logger) Errorf(format string, args ...interface{}) { |
| 330 | l.log.Errorf(format, args...) |
| 331 | } |
| 332 | |
| 333 | // Errorw logs a message with some additional context. The variadic key-value |
| 334 | // pairs are treated as they are in With. |
| 335 | func (l logger) Errorw(msg string, keysAndValues Fields) { |
| 336 | l.log.Errorw(msg, serializeMap(keysAndValues)...) |
| 337 | } |
| 338 | |
| 339 | // Fatal logs a message at level Fatal on the standard logger. |
| 340 | func (l logger) Fatal(args ...interface{}) { |
| 341 | l.log.Fatal(args...) |
| 342 | } |
| 343 | |
| 344 | // Fatalln logs a message at level Fatal on the standard logger with a line feed. Default in any case. |
| 345 | func (l logger) Fatalln(args ...interface{}) { |
| 346 | l.log.Fatal(args...) |
| 347 | } |
| 348 | |
| 349 | // Fatalf logs a message at level Fatal on the standard logger. |
| 350 | func (l logger) Fatalf(format string, args ...interface{}) { |
| 351 | l.log.Fatalf(format, args...) |
| 352 | } |
| 353 | |
| 354 | // Fatalw logs a message with some additional context. The variadic key-value |
| 355 | // pairs are treated as they are in With. |
| 356 | func (l logger) Fatalw(msg string, keysAndValues Fields) { |
| 357 | l.log.Fatalw(msg, serializeMap(keysAndValues)...) |
| 358 | } |
| 359 | |
| 360 | // With returns a logger initialized with the key-value pairs |
| 361 | func With(keysAndValues Fields) Logger { |
| 362 | return logger{log: defaultLogger.sourced().With(serializeMap(keysAndValues)...), parent: defaultLogger.parent} |
| 363 | } |
| 364 | |
| 365 | // Debug logs a message at level Debug on the standard logger. |
| 366 | func Debug(args ...interface{}) { |
| 367 | defaultLogger.sourced().Debug(args...) |
| 368 | } |
| 369 | |
| 370 | // Debugln logs a message at level Debug on the standard logger. |
| 371 | func Debugln(args ...interface{}) { |
| 372 | defaultLogger.sourced().Debug(args...) |
| 373 | } |
| 374 | |
| 375 | // Debugf logs a message at level Debug on the standard logger. |
| 376 | func Debugf(format string, args ...interface{}) { |
| 377 | defaultLogger.sourced().Debugf(format, args...) |
| 378 | } |
| 379 | |
| 380 | // Debugw logs a message with some additional context. The variadic key-value |
| 381 | // pairs are treated as they are in With. |
| 382 | func Debugw(msg string, keysAndValues Fields) { |
| 383 | defaultLogger.sourced().Debugw(msg, serializeMap(keysAndValues)...) |
| 384 | } |
| 385 | |
| 386 | // Info logs a message at level Info on the standard logger. |
| 387 | func Info(args ...interface{}) { |
| 388 | defaultLogger.sourced().Info(args...) |
| 389 | } |
| 390 | |
| 391 | // Infoln logs a message at level Info on the standard logger. |
| 392 | func Infoln(args ...interface{}) { |
| 393 | defaultLogger.sourced().Info(args...) |
| 394 | } |
| 395 | |
| 396 | // Infof logs a message at level Info on the standard logger. |
| 397 | func Infof(format string, args ...interface{}) { |
| 398 | defaultLogger.sourced().Infof(format, args...) |
| 399 | } |
| 400 | |
| 401 | //Infow logs a message with some additional context. The variadic key-value |
| 402 | //pairs are treated as they are in With. |
| 403 | func Infow(msg string, keysAndValues Fields) { |
| 404 | defaultLogger.sourced().Infow(msg, serializeMap(keysAndValues)...) |
| 405 | } |
| 406 | |
| 407 | // Warn logs a message at level Warn on the standard logger. |
| 408 | func Warn(args ...interface{}) { |
| 409 | defaultLogger.sourced().Warn(args...) |
| 410 | } |
| 411 | |
| 412 | // Warnln logs a message at level Warn on the standard logger. |
| 413 | func Warnln(args ...interface{}) { |
| 414 | defaultLogger.sourced().Warn(args...) |
| 415 | } |
| 416 | |
| 417 | // Warnf logs a message at level Warn on the standard logger. |
| 418 | func Warnf(format string, args ...interface{}) { |
| 419 | defaultLogger.sourced().Warnf(format, args...) |
| 420 | } |
| 421 | |
| 422 | // Warnw logs a message with some additional context. The variadic key-value |
| 423 | // pairs are treated as they are in With. |
| 424 | func Warnw(msg string, keysAndValues Fields) { |
| 425 | defaultLogger.sourced().Warnw(msg, serializeMap(keysAndValues)...) |
| 426 | } |
| 427 | |
| 428 | // Error logs a message at level Error on the standard logger. |
| 429 | func Error(args ...interface{}) { |
| 430 | defaultLogger.sourced().Error(args...) |
| 431 | } |
| 432 | |
| 433 | // Errorln logs a message at level Error on the standard logger. |
| 434 | func Errorln(args ...interface{}) { |
| 435 | defaultLogger.sourced().Error(args...) |
| 436 | } |
| 437 | |
| 438 | // Errorf logs a message at level Error on the standard logger. |
| 439 | func Errorf(format string, args ...interface{}) { |
| 440 | defaultLogger.sourced().Errorf(format, args...) |
| 441 | } |
| 442 | |
| 443 | // Errorw logs a message with some additional context. The variadic key-value |
| 444 | // pairs are treated as they are in With. |
| 445 | func Errorw(msg string, keysAndValues Fields) { |
| 446 | defaultLogger.sourced().Errorw(msg, serializeMap(keysAndValues)...) |
| 447 | } |
| 448 | |
| 449 | // Fatal logs a message at level Fatal on the standard logger. |
| 450 | func Fatal(args ...interface{}) { |
| 451 | defaultLogger.sourced().Fatal(args...) |
| 452 | } |
| 453 | |
| 454 | // Fatalln logs a message at level Fatal on the standard logger. |
| 455 | func Fatalln(args ...interface{}) { |
| 456 | defaultLogger.sourced().Fatal(args...) |
| 457 | } |
| 458 | |
| 459 | // Fatalf logs a message at level Fatal on the standard logger. |
| 460 | func Fatalf(format string, args ...interface{}) { |
| 461 | defaultLogger.sourced().Fatalf(format, args...) |
| 462 | } |
| 463 | |
| 464 | // Fatalw logs a message with some additional context. The variadic key-value |
| 465 | // pairs are treated as they are in With. |
| 466 | func Fatalw(msg string, keysAndValues Fields) { |
| 467 | defaultLogger.sourced().Fatalw(msg, serializeMap(keysAndValues)...) |
| 468 | } |