[SPARK-48592][INFRA] Add structured logging style script and GitHub workflow #47239
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
LuciferYang
reviewed
Jul 8, 2024
LuciferYang
reviewed
Jul 9, 2024
HyukjinKwon
reviewed
Jul 11, 2024
HyukjinKwon
reviewed
Jul 11, 2024
HyukjinKwon
reviewed
Jul 11, 2024
HyukjinKwon
reviewed
Jul 11, 2024
gengliangwang
approved these changes
Jul 11, 2024
|
Thanks, merging to master |
jingz-db
pushed a commit
to jingz-db/spark
that referenced
this pull request
Jul 22, 2024
…orkflow
### What changes were proposed in this pull request?
This PR checks for Scala logging messages using logInfo, logWarning, logError and containing variables without MDC wrapper
Example error output:
```
[error] spark/mllib/src/main/scala/org/apache/spark/mllib/clustering/StreamingKMeans.scala:225:4
[error] Logging message should use Structured Logging Framework style, such as log"...${MDC(TASK_ID, taskId)..."
Refer to the guidelines in the file `internal/Logging.scala`.
```
### Why are the changes needed?
This makes development and PR review of the structured logging migration easier.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Manual test, verified it will throw errors on invalid logging messages.
### Was this patch authored or co-authored using generative AI tooling?
No
Closes apache#47239 from asl3/structuredlogstylescript.
Authored-by: Amanda Liu <amanda.liu@databricks.com>
Signed-off-by: Gengliang Wang <gengliang@apache.org>
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?
This PR checks for Scala logging messages using logInfo, logWarning, logError and containing variables without MDC wrapper
Example error output:
Why are the changes needed?
This makes development and PR review of the structured logging migration easier.
Does this PR introduce any user-facing change?
No
How was this patch tested?
Manual test, verified it will throw errors on invalid logging messages.
Was this patch authored or co-authored using generative AI tooling?
No