[v1, 4/8] Replace NewJSON constructor with NewLogger #115
Conversation
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
added 2 commits
August 1, 2016 10:01
Since loggers and encoders are now completely separate, make the main constructor `NewLogger` and have it take an encoder as its first argument. This requires changing many call sites.
|
Did you consider this alternate interface:
This makes creating a new default logger a fair bit more verbose: zap.NewLogger(zap.NewJSONEncoder(), [..])vs zap.New([...])And in the case that someone wants to customize the encoder, it's not very complicated either: zap.New(zap.Encoder(zap.NewJSONEncoder()), [...]) |
|
I considered that (and roughed out some code), but ended up rejecting it for two reasons:
|
| @@ -86,7 +86,12 @@ func BenchmarkZapDisabledLevelsWithoutFields(b *testing.B) { | |||
|
|
|||
| func BenchmarkZapDisabledLevelsAccumulatedContext(b *testing.B) { | |||
| context := fakeFields() | |||
| logger := zap.NewJSON(zap.ErrorLevel, zap.Output(zap.Discard), zap.Fields(context...)) | |||
| logger := zap.NewLogger( | |||
There was a problem hiding this comment.
Optional: might be worth adding a helper to create a new JSON logger with output discarded, that takes a list of additional options on top.
|
Makes sense. lgtm |
|
Will change |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Make the logger type name more generic, since it's not actually JSON-specific, and make the logger constructor take an encoder implementation. Since we're injecting encoders, we can stop using the ugly
StubTimehack (which we'll remove altogether in the next PR).This is the fourth of eight PRs to finish up the large pre-v1.0.0 refactoring:
NewLoggerconstructor and removeNewJSONStubTimeEncoder.AddFields(since we already haveField.AddTo)The remaining items in the v1 milestone shouldn't require large-scale changes.