Add supplier pattern to avoid message creation overhead. #100
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
thespags
commented
Nov 11, 2021
| @@ -13,6 +13,10 @@ var _ Interface = (*Entry)(nil) | |||
| // Now returns the current time. | |||
| var Now = time.Now | |||
|
|
|||
| // logSupplier Allows lazy creation of strings for logging. | |||
| // If the log line is skipped then this supplier will not be invoked. | |||
| type logSupplier func() string | |||
There was a problem hiding this comment.
The supplier function that will be invoked.
thespags
commented
Nov 11, 2021
| if level < l.Level { | ||
| return | ||
| } | ||
| l.log(level, e, msg()) |
There was a problem hiding this comment.
Skips invoking msg() if level is not met otherwise creates the message and defer to the main logging flow.
| Level: log.InfoLevel, | ||
| } | ||
|
|
||
| l.Debugl(func() string { assert.Fail(t, "Supplier should not be invoked."); return "ignored"}) |
There was a problem hiding this comment.
Tests that this supplier is never invoked otherwise the test would fail. If I remove line 181 with the level skip the test fails.
|
Hi @tj. I was wondering how often you get a chance to review PRs to this repo. I noticed there wasn't any updates in the last year. Thank you! |
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.
The supplier will only be invoked if the log line's level is met. Otherwise we avoid string creation. This is to optimize applications that may want to minimize extra string creation overhead.