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
Next Next commit
[SPARK-48592][INFRA] Add scala style check for logging message inline… 
… variables
  • Loading branch information
@asl3
asl3 committed Jun 12, 2024
commit 47710c92bc5077ddb9a91db7b088b901e07bce88
8 changes: 8 additions & 0 deletions scalastyle-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,14 @@ This file is divided into 3 sections:
<customMessage><![CDATA[MDC should be used in string interpolation log"..." instead of s"..."]]></customMessage>
</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>
Copy link
Member

@gengliangwang gengliangwang Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to detect the ".format(..)` as well.
Also, need to exclude the testing code.

Copy link
Contributor

@LuciferYang LuciferYang Jun 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar rules also need to be added to dev/checkstyle.xml to check Java code

Copy link
Contributor

@LuciferYang LuciferYang Jun 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, need to exclude the testing code.

This might be difficult, as for scalastyle-maven-plugin, there is currently no mechanism similar to Java checkstyle's SuppressionFilter that can ignore certain rules in specific files or code blocks. The rule ignoring of scalastyle is global and cannot be targeted at specific files or code blocks. After defining the check rule, we may only be able to skip the relevant checks in a way similar to the following:

// scalastyle:off logInlineVariable
logInfo(s"....")
// scalastyle:on logInlineVariable

<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`.
</customMessage>
</check>

<check customId="hadoopconfiguration" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters><parameter name="regex">spark(.sqlContext)?.sparkContext.hadoopConfiguration</parameter></parameters>
<customMessage><![CDATA[
Expand Down