-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added RS Zerolog logging adapter (#96)
* Added RS Zerolog logging adapter Signed-off-by: Mate Lang <mate.lang@welthee.com> * Fixed pull request review comments Signed-off-by: Mate Lang <mate.lang@welthee.com>
- Loading branch information
Máté Lang
authored
Oct 15, 2021
1 parent
515fb0c
commit 1df73a4
Showing
4 changed files
with
212 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * Copyright (c) 2019 VMware, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and | ||
| * associated documentation files (the "Software"), to deal in the Software without restriction, including | ||
| * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is furnished to do | ||
| * so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or substantial | ||
| * portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT | ||
| * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
| * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
| * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
| // Note: The implementation comes from https://www.mountedthoughts.com/golang-logger-interface/ | ||
| // https://github.com/amitrai48/logger | ||
|
|
||
| // Package zerolog implements the KCL logger using RS Zerolog logger | ||
| package zerolog | ||
|
|
||
| import ( | ||
| "github.com/rs/zerolog" | ||
| "github.com/vmware/vmware-go-kcl/logger" | ||
| "gopkg.in/natefinch/lumberjack.v2" | ||
| "os" | ||
| ) | ||
|
|
||
| type zeroLogger struct { | ||
| log zerolog.Logger | ||
| } | ||
|
|
||
| // NewZerologLogger creates a new logger.Logger backed by RS Zerolog using a default config | ||
| func NewZerologLogger() logger.Logger { | ||
| return NewZerologLoggerWithConfig(logger.Configuration{ | ||
| EnableConsole: true, | ||
| ConsoleJSONFormat: true, | ||
| ConsoleLevel: logger.Info, | ||
| EnableFile: false, | ||
| FileJSONFormat: false, | ||
| FileLevel: logger.Info, | ||
| Filename: "", | ||
| MaxSizeMB: 0, | ||
| MaxAgeDays: 0, | ||
| MaxBackups: 0, | ||
| LocalTime: true, | ||
| }) | ||
| } | ||
|
|
||
| // NewZerologLoggerWithConfig creates a new logger.Logger backed by RS Zerolog using the provided config | ||
| func NewZerologLoggerWithConfig(config logger.Configuration) logger.Logger { | ||
| var consoleHandler *zerolog.ConsoleWriter | ||
| var fileHandler *lumberjack.Logger | ||
| var finalLogger zerolog.Logger | ||
|
|
||
| normalizeConfig(&config) | ||
|
|
||
| if config.EnableConsole { | ||
| consoleHandler = &zerolog.ConsoleWriter{Out: os.Stdout} | ||
| } | ||
|
|
||
| if config.EnableFile { | ||
| fileHandler = &lumberjack.Logger{ | ||
| Filename: config.Filename, | ||
| MaxSize: config.MaxSizeMB, | ||
| Compress: true, | ||
| MaxAge: config.MaxAgeDays, | ||
| MaxBackups: config.MaxBackups, | ||
| LocalTime: config.LocalTime, | ||
| } | ||
| } | ||
|
|
||
| if config.EnableConsole && config.EnableFile { | ||
| multi := zerolog.MultiLevelWriter(consoleHandler, fileHandler) | ||
| finalLogger = zerolog.New(multi).Level(getZeroLogLevel(config.ConsoleLevel)).With().Timestamp().Logger() | ||
| } else if config.EnableFile { | ||
| finalLogger = zerolog.New(fileHandler).Level(getZeroLogLevel(config.FileLevel)).With().Timestamp().Logger() | ||
| } else { | ||
| finalLogger = zerolog.New(consoleHandler).Level(getZeroLogLevel(config.ConsoleLevel)).With().Timestamp().Logger() | ||
| } | ||
|
|
||
| return &zeroLogger{log: finalLogger} | ||
| } | ||
|
|
||
| func (z *zeroLogger) Debugf(format string, args ...interface{}) { | ||
| z.log.Debug().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) Infof(format string, args ...interface{}) { | ||
| z.log.Info().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) Warnf(format string, args ...interface{}) { | ||
| z.log.Warn().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) Errorf(format string, args ...interface{}) { | ||
| z.log.Error().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) Fatalf(format string, args ...interface{}) { | ||
| z.log.Fatal().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) Panicf(format string, args ...interface{}) { | ||
| z.log.Panic().Msgf(format, args...) | ||
| } | ||
|
|
||
| func (z *zeroLogger) WithFields(keyValues logger.Fields) logger.Logger { | ||
| newLogger := z.log.With() | ||
| for k, v := range keyValues { | ||
| newLogger.Interface(k, v) | ||
| } | ||
|
|
||
| return &zeroLogger{ | ||
| log: newLogger.Logger(), | ||
| } | ||
| } | ||
|
|
||
| func getZeroLogLevel(level string) zerolog.Level { | ||
| switch level { | ||
| case logger.Info: | ||
| return zerolog.InfoLevel | ||
| case logger.Warn: | ||
| return zerolog.WarnLevel | ||
| case logger.Debug: | ||
| return zerolog.DebugLevel | ||
| case logger.Error: | ||
| return zerolog.ErrorLevel | ||
| case logger.Fatal: | ||
| return zerolog.FatalLevel | ||
| default: | ||
| return zerolog.InfoLevel | ||
| } | ||
| } | ||
|
|
||
| func normalizeConfig(config *logger.Configuration) { | ||
| if config.MaxSizeMB <= 0 { | ||
| config.MaxSizeMB = 100 | ||
| } | ||
|
|
||
| if config.MaxAgeDays <= 0 { | ||
| config.MaxAgeDays = 7 | ||
| } | ||
|
|
||
| if config.MaxBackups < 0 { | ||
| config.MaxBackups = 0 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package zerolog | ||
|
|
||
| import ( | ||
| "github.com/vmware/vmware-go-kcl/logger" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestZeroLogLoggerWithConfig(t *testing.T) { | ||
| config := logger.Configuration{ | ||
| EnableConsole: true, | ||
| ConsoleLevel: logger.Debug, | ||
| ConsoleJSONFormat: true, | ||
| EnableFile: true, | ||
| FileLevel: logger.Info, | ||
| FileJSONFormat: false, | ||
| Filename: "/tmp/kcl-zerolog-log.log", | ||
| } | ||
|
|
||
| log := NewZerologLoggerWithConfig(config) | ||
|
|
||
| contextLogger := log.WithFields(logger.Fields{"key1": "value1"}) | ||
| contextLogger.Debugf("Starting with rs zerolog") | ||
| contextLogger.Infof("Rs zerolog is awesome") | ||
| } | ||
|
|
||
| func TestZeroLogLogger(t *testing.T) { | ||
| log := NewZerologLogger() | ||
|
|
||
| contextLogger := log.WithFields(logger.Fields{"key1": "value1"}) | ||
| contextLogger.Debugf("Starting with zerolog") | ||
| contextLogger.Infof("Zerolog is awesome") | ||
| } |