[SPARK-48592][INFRA] Add structured logging style script and GitHub workflow #47239
Conversation
This file contains hidden or 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
Member
HyukjinKwon
left a comment
HyukjinKwon
left a comment
There was a problem hiding this comment.
Seems fine from a cursory look
gengliangwang
approved these changes
Jul 11, 2024
Member
|
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 <[email protected]>
Signed-off-by: Gengliang Wang <[email protected]>
5 tasks
scottsand-db
pushed a commit
to delta-io/delta
that referenced
this pull request
Nov 5, 2024
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://github.com/delta-io/delta/blob/master/CONTRIBUTING.md 2. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP] Your PR title ...'. 3. Be sure to keep the PR description updated to reflect all changes. 4. Please write your PR title to summarize what this PR proposes. 5. If possible, provide a concise example to reproduce the issue for a faster review. 6. If applicable, include the corresponding issue number in the PR title and link it in the body. --> #### Which Delta project/connector is this regarding? <!-- Please add the component selected below to the beginning of the pull request title For example: [Spark] Title of my pull request --> - [ ] Spark - [ ] Standalone - [ ] Flink - [ ] Kernel - [x] Other (Infra) ## Description <!-- - Describe what this PR changes. - Describe why we need the change. If this PR resolves an issue be sure to include "Resolves #XXX" to correctly link and close the issue upon merge. --> Add a python linter script to enforce new code to adhere to structured logging. There is a similar effort in Spark: apache/spark#47239. ## How was this patch tested? <!-- If tests were added, say they were added here. Please make sure to test the changes thoroughly including negative and positive cases if possible. If the changes were tested in any way other than unit tests, please clarify how you tested step by step (ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future). If the changes were not tested, please explain why. --> github workflow passed. ## Does this PR introduce _any_ user-facing changes? <!-- If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible. If possible, please also clarify if this is a user-facing change compared to the released Delta Lake versions or within the unreleased branches such as master. If no, write 'No'. --> No
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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