[SPARK-48744][Core] Log entry should be constructed only once #47135
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
|
cc @panbingkun |
HyukjinKwon
approved these changes
Jun 27, 2024
cloud-fan
approved these changes
Jun 28, 2024
panbingkun
reviewed
Jun 28, 2024
| @@ -228,6 +228,37 @@ trait LoggingSuiteBase | |||
| verifyMsgWithConcat(level, logOutput) | |||
| } | |||
| } | |||
|
|
|||
| test("LogEntry should construct MessageWithContext only once") { | |||
There was a problem hiding this comment.
Perhaps we should put the above testing logic into MDCSuite or a new UT (eg: MessageWithContextSuite), as it seems unrelated to the classification of structured and pattern logs, so it will be executed twice in GA?
There was a problem hiding this comment.
A test takes 200ms, running twice is ok. Also, we need to ensure the log entry is constructed only once when structured logging is disabled, too.
|
This is really a great improvement! |
yaooqinn
approved these changes
Jun 28, 2024
|
Merging to master |
asl3
pushed a commit
to asl3/spark
that referenced
this pull request
Jul 1, 2024
### What changes were proposed in this pull request?
In the current implementation:
```
class LogEntry(messageWithContext: => MessageWithContext) {
def message: String = messageWithContext.message
def context: java.util.HashMap[String, String] = messageWithContext.context
}
def logInfo(entry: LogEntry): Unit = {
if (log.isInfoEnabled) {
withLogContext(entry.context) {
log.info(entry.message)
}
}
}
```
The field `messageWithContext` is constructed twice, one from `entry.context` and another one from `entry.message`.
This PR is to improve this and ensure a log entry is constructed only once.
### Why are the changes needed?
Improve the performance of logging
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
New UT
### Was this patch authored or co-authored using generative AI tooling?
No
Closes apache#47135 from gengliangwang/addCache.
Authored-by: Gengliang Wang <[email protected]>
Signed-off-by: Gengliang Wang <[email protected]>
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.
What changes were proposed in this pull request?
In the current implementation:
The field
messageWithContextis constructed twice, one fromentry.contextand another one fromentry.message.This PR is to improve this and ensure a log entry is constructed only once.
Why are the changes needed?
Improve the performance of logging
Does this PR introduce any user-facing change?
No
How was this patch tested?
New UT
Was this patch authored or co-authored using generative AI tooling?
No