zapcore: Add LevelOf(LevelEnabler), UnknownLevel #1147
Merged
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
Add a new function LevelOf that reports the minimum enabled log level for a LevelEnabler. This works by looping through all known Zap levels in-order, returning the newly introduced UnknownLevel if none of the known levels are enabled. A LevelEnabler or Core implementation may implement the `Level() Level` method to override and optimize this behavior. AtomicLevel already implemented this method. This change adds the method to all Core implementations shipped with Zap. Note: UnknownLevel is set at FatalLevel+1 to account for the possibility that users of Zap are using DebugLevel-1 as their own custom log level--even though this isn't supported, it's preferable not to break these users. Users are less likely to use FatalLevel+1 since Fatal means "exit the application." Resolves #1144 Supersedes #1143, which was not backwards compatible
Codecov Report
@@ Coverage Diff @@
## master #1147 +/- ##
==========================================
+ Coverage 98.32% 98.33% +0.01%
==========================================
Files 49 49
Lines 2146 2160 +14
==========================================
+ Hits 2110 2124 +14
Misses 28 28
Partials 8 8
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
mway
reviewed
Aug 15, 2022
zapcore/level.go
Outdated
| // UnknownLevel is an invalid value for Level. | ||
| // | ||
| // Core implementations may panic if they see messages of this level. | ||
| UnknownLevel = _maxLevel + 1 |
There was a problem hiding this comment.
Can we reorganize these so that we have an invalid zero value? e.g.
const (
InvalidLevel = iota
DebugLevel
// ...
FatalLevel
_minLevel = DebugLevel
_maxLevel = FatalLevel
)
There was a problem hiding this comment.
Wouldn't this be a breaking change because the integer value of DebugLevel (and everything else) would change?
There was a problem hiding this comment.
I lean towards not changing values of published constants, even if the line around whether it's a breaking change is a bit blurry. Such a change will break someone, and we don't get much in exchange.
zapcore/level.go
Outdated
| // UnknownLevel is an invalid value for Level. | ||
| // | ||
| // Core implementations may panic if they see messages of this level. | ||
| UnknownLevel = _maxLevel + 1 |
sywhang
approved these changes
Aug 15, 2022
sywhang
approved these changes
Aug 16, 2022
mway
approved these changes
Aug 16, 2022
abhinav
added a commit
that referenced
this pull request
Aug 30, 2022
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.
Add a new function LevelOf that reports the minimum enabled log level
for a LevelEnabler.
This works by looping through all known Zap levels in-order,
returning the newly introduced UnknownLevel if none of the known levels
are enabled.
A LevelEnabler or Core implementation may implement the
Level() Levelmethod to override and optimize this behavior.
AtomicLevel already implemented this method.
This change adds the method to all Core implementations shipped with
Zap.
Note:
UnknownLevel is set at FatalLevel+1 to account for the possibility that
users of Zap are using DebugLevel-1 as their own custom log level--even
though this isn't supported, it's preferable not to break these users.
Users are less likely to use FatalLevel+1 since Fatal means "exit the
application."
Refs #1144
Supersedes #1143, which was not backwards compatible
Refs GO-1586