Skip to content

[SPARK-48592][INFRA] Add scala style check for logging message inline variables #46947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
asl3 wants to merge 10 commits into from
Closed

[SPARK-48592][INFRA] Add scala style check for logging message inline variables #46947

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
47710c9
[SPARK-48592][INFRA] Add scala style check for logging message inline…
asl3 Jun 12, 2024
9a10dd8
check for .format(...)
asl3 Jun 13, 2024
5b90508
Merge branch 'master' into logging-stringinterpolation
asl3 Jun 20, 2024
0456ac9
special case warn
asl3 Jun 24, 2024
cfffcdb
add prod-only xml config file
asl3 Jun 24, 2024
3b603ae
concat rules in scalastyle-config and scalastyle-config-prod
asl3 Jun 24, 2024
4077778
xml style
asl3 Jun 25, 2024
3b00bbc
style
asl3 Jul 1, 2024
22af7ed
style
asl3 Jul 1, 2024
26d7681
trim extra scalastyle
asl3 Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
check for .format(...)
  • Loading branch information
@asl3
asl3 committed Jun 13, 2024
commit 9a10dd8b2bd1ff801f07af01e391541173a328b8
2 changes: 1 addition & 1 deletion scalastyle-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ This file is divided into 3 sections:
</check>

<check customId="logInlineVariable" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters><parameter name="regex">log(?:Info|Warning|Error)\(s".*(\$|\+\s*[^\s"]).*"\)</parameter></parameters>
<parameters><parameter name="regex">log(?:Info|Warning|Error)\((?:".*"\.format\(.*\)|s".*(?:\$|\+\s*[^\s"]).*"\))</parameter></parameters>
<customMessage>
Logging message should use log"..." instead of s"..." and variables should be wrapped in `MDC`s.
Refer to Structured Logging Framework guidelines in the file `internal/Logging.scala`.
Expand Down