forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: rename log pkg and add zerolog (cosmos#14955)
- Loading branch information
1 parent
bd8e9f2
commit a7ac29e
Showing
94 changed files
with
393 additions
and
189 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
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
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,3 @@ | ||
| # Log | ||
|
|
||
| The `cosmossdk.io/log` provides simple logging implementations for the Cosmos SDK and Cosmos SDK modules. |
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 |
|---|---|---|
| @@ -1,11 +1,17 @@ | ||
| module github.com/cosmos/cosmos-sdk/log | ||
| module cosmossdk.io/log | ||
|
|
||
| go 1.19 | ||
|
|
||
| require github.com/cometbft/cometbft v0.0.0-20230203130311-387422ac220d | ||
| require ( | ||
| github.com/cometbft/cometbft v0.0.0-20230203130311-387422ac220d | ||
| github.com/rs/zerolog v1.28.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/go-kit/log v0.2.1 // indirect | ||
| github.com/go-logfmt/logfmt v0.5.1 // indirect | ||
| github.com/mattn/go-colorable v0.1.13 // indirect | ||
| github.com/mattn/go-isatty v0.0.16 // indirect | ||
| github.com/pkg/errors v0.9.1 // indirect | ||
| golang.org/x/sys v0.4.0 // indirect | ||
| ) |
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 |
|---|---|---|
| @@ -1,12 +1,28 @@ | ||
| github.com/cometbft/cometbft v0.0.0-20230203130311-387422ac220d h1:akhMrKe9V6+f+K8Brq3Cx+I2kRIizVsnU6+frARVTzo= | ||
| github.com/cometbft/cometbft v0.0.0-20230203130311-387422ac220d/go.mod h1:EZUXFIzOBV/rscOektBL3X4FI5zHpu7tQMNNMwzv4ac= | ||
| github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/go-kit/log v0.2.1 h1:MRVx0/zhvdseW+Gza6N9rVzU/IVzaeE1SFI4raAhmBU= | ||
| github.com/go-kit/log v0.2.1/go.mod h1:NwTd00d/i8cPZ3xOwwiv2PO5MOcx78fFErGNcVmBjv0= | ||
| github.com/go-logfmt/logfmt v0.5.1 h1:otpy5pqBCBZ1ng9RQ0dPu4PN7ba75Y/aA+UpowDyNVA= | ||
| github.com/go-logfmt/logfmt v0.5.1/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs= | ||
| github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= | ||
| github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= | ||
| github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= | ||
| github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= | ||
| github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= | ||
| github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= | ||
| github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= | ||
| github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= | ||
| github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
| github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= | ||
| github.com/rs/zerolog v1.28.0 h1:MirSo27VyNi7RJYP3078AA1+Cyzd2GB66qy3aUHvsWY= | ||
| github.com/rs/zerolog v1.28.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= | ||
| github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= | ||
| golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18= | ||
| golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= |
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 |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| package log | ||
|
|
||
| import cmlog "github.com/cometbft/cometbft/libs/log" | ||
| import cmtlog "github.com/cometbft/cometbft/libs/log" | ||
|
|
||
| // Logger is the interface that wraps the basic logging methods. | ||
| type Logger interface { | ||
| Debug(msg string, keyvals ...interface{}) | ||
| Info(msg string, keyvals ...interface{}) | ||
| Error(msg string, keyvals ...interface{}) | ||
|
|
||
| With(keyvals ...interface{}) cmlog.Logger | ||
| With(keyvals ...interface{}) cmtlog.Logger | ||
| } |
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,73 @@ | ||
| package log | ||
|
|
||
| import ( | ||
| "os" | ||
| "time" | ||
|
|
||
| cmtlog "github.com/cometbft/cometbft/libs/log" | ||
| "github.com/rs/zerolog" | ||
| ) | ||
|
|
||
| // Defines commons keys for logging | ||
| const ModuleKey = "module" | ||
|
|
||
| var ( | ||
| // ContextKey is used to store the logger in the context | ||
| ContextKey struct{} | ||
| _ Logger = (*ZeroLogWrapper)(nil) | ||
| ) | ||
|
|
||
| func NewZeroLogger(key, value string) *zerolog.Logger { | ||
| output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.Kitchen} | ||
| logger := zerolog.New(output).With().Str(key, value).Timestamp().Logger() | ||
| return &logger | ||
| } | ||
|
|
||
| // TODO: add filtered logging in ZeroLog: https://github.com/cosmos/cosmos-sdk/pull/13236 / https://github.com/cosmos/cosmos-sdk/issues/13699#issuecomment-1354887644 | ||
|
|
||
| // ZeroLogWrapper provides a wrapper around a zerolog.Logger instance. It implements | ||
| // Tendermint's Logger interface. | ||
| type ZeroLogWrapper struct { | ||
| zerolog.Logger | ||
| } | ||
|
|
||
| // Info implements Tendermint's Logger interface and logs with level INFO. A set | ||
| // of key/value tuples may be provided to add context to the log. The number of | ||
| // tuples must be even and the key of the tuple must be a string. | ||
| func (z ZeroLogWrapper) Info(msg string, keyVals ...interface{}) { | ||
| z.Logger.Info().Fields(getLogFields(keyVals...)).Msg(msg) | ||
| } | ||
|
|
||
| // Error implements Tendermint's Logger interface and logs with level ERR. A set | ||
| // of key/value tuples may be provided to add context to the log. The number of | ||
| // tuples must be even and the key of the tuple must be a string. | ||
| func (z ZeroLogWrapper) Error(msg string, keyVals ...interface{}) { | ||
| z.Logger.Error().Fields(getLogFields(keyVals...)).Msg(msg) | ||
| } | ||
|
|
||
| // Debug implements Tendermint's Logger interface and logs with level DEBUG. A set | ||
| // of key/value tuples may be provided to add context to the log. The number of | ||
| // tuples must be even and the key of the tuple must be a string. | ||
| func (z ZeroLogWrapper) Debug(msg string, keyVals ...interface{}) { | ||
| z.Logger.Debug().Fields(getLogFields(keyVals...)).Msg(msg) | ||
| } | ||
|
|
||
| // With returns a new wrapped logger with additional context provided by a set | ||
| // of key/value tuples. The number of tuples must be even and the key of the | ||
| // tuple must be a string. | ||
| func (z ZeroLogWrapper) With(keyVals ...interface{}) cmtlog.Logger { | ||
| return ZeroLogWrapper{z.Logger.With().Fields(getLogFields(keyVals...)).Logger()} | ||
| } | ||
|
|
||
| func getLogFields(keyVals ...interface{}) map[string]interface{} { | ||
| if len(keyVals)%2 != 0 { | ||
| return nil | ||
| } | ||
|
|
||
| fields := make(map[string]interface{}) | ||
| for i := 0; i < len(keyVals); i += 2 { | ||
| fields[keyVals[i].(string)] = keyVals[i+1] | ||
| } | ||
|
|
||
| return fields | ||
| } |
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
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
Oops, something went wrong.