-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor Logging using Zerolog #8072
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
35536c6
init commit
alexanderbez fde418d
server: use flags
alexanderbez 35da7bc
server: godoc++
alexanderbez aee6a0c
updates
alexanderbez 823bfe8
baseapp: update logging
alexanderbez b78ce01
logging updates
alexanderbez 6781f7e
x/bank: update logging
alexanderbez a9c5866
logging updates
alexanderbez be4a1ee
lint++
alexanderbez fbd45f2
logging updates
alexanderbez 4f53a92
logging updates
alexanderbez 7c559ec
logging updates
alexanderbez 8959901
logging updates
alexanderbez daa80b9
cl++
alexanderbez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
package server | ||
alessio marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
import ( | ||
"github.com/rs/zerolog" | ||
tmlog "github.com/tendermint/tendermint/libs/log" | ||
) | ||
|
||
var _ tmlog.Logger = (*ZeroLogWrapper)(nil) | ||
|
||
// 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{}) tmlog.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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For local networks that are used for testing, human readable/friendly logs are preferable.