asl3 commented on code in PR #47239: URL: https://github.com/apache/spark/pull/47239#discussion_r1667171001
########## dev/structured-logging.py: ########## @@ -0,0 +1,64 @@ +#!/usr/bin/env python3 + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import os +import sys +import re +import glob + +from sparktestsupport import SPARK_HOME + +def main(): + nonmigrated_pattern = r'log(Info|Warning|Error)\((?:".*"\.format\(.*\)|s".*(?:\$|\+\s*[^\s"]).*"\))' + whitelist_file = 'dev/structured-logging-whitelist.txt' + + nonmigrated_files = [] + whitelist_files = set() + + with open(whitelist_file, 'r') as wf: + whitelist_patterns = [line.strip() for line in wf if line.strip()] + + scala_files = glob.glob(os.path.join(SPARK_HOME, '**', '*.scala'), recursive=True) + + for file in scala_files: + for whitelist_pattern in whitelist_patterns: + if re.search(whitelist_pattern, file): + whitelist_files.add(file) + break + + for file in scala_files: + if file not in whitelist_files: + with open(file, 'r') as f: + content = f.read().replace('\t', '').strip() + if re.search(nonmigrated_pattern, content): + nonmigrated_files.append(file) + + if not nonmigrated_files: + print("Structured logging style check passed.") + sys.exit(0) + else: + print("Structured logging style check failed for the following:") + for file in nonmigrated_files: + print(file) Review Comment: adjusting the error message to match the format of `build/sbt` errors: ``` [error]/Users/amanda.liu/Documents/Databricks/spark/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/codegen/CodeGenerator.scala:1564:6 [error] 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`. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
