gengliangwang commented on code in PR #47145: URL: https://github.com/apache/spark/pull/47145#discussion_r1669734425
########## python/docs/source/development/logger.rst: ########## @@ -0,0 +1,151 @@ +.. 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. + +================== +Logging in PySpark +================== + +.. currentmodule:: pyspark.logger + +Introduction +============ + +The :ref:`pyspark.logger</reference/pyspark.logger.rst>` module facilitates structured client-side logging for PySpark users. + +This module includes a :class:`PySparkLogger` class that provides several methods for logging messages at different levels in a structured JSON format: + +- :meth:`PySparkLogger.log_info` +- :meth:`PySparkLogger.log_warn` +- :meth:`PySparkLogger.log_error` + +The logger can be easily configured to write logs to either the console or a specified file. + +Customizing Log Format +====================== +The default log format is JSON, which includes the timestamp, log level, logger name, and the log message along with any additional context provided. + +Example log entry: + +.. code-block:: python + + { + "ts": "2024-06-28T10:53:48.528Z", + "level": "ERROR", + "logger": "DataFrameQueryContextLogger", + "msg": "[DIVIDE_BY_ZERO] Division by zero.", + "context": { + "file": "/path/to/file.py", Review Comment: In log4j, there are APIs with `Throwable`(for example: https://logging.apache.org/log4j/2.x/javadoc/log4j-api/org/apache/logging/log4j/Logger.html#error(java.lang.Object,java.lang.Throwable) So in scala side, we have a field for exceptions. ``` |exception STRUCT< | class STRING, | msg STRING, | stacktrace ARRAY<STRUCT< | class STRING, | method STRING, | file STRING, | line STRING | >> |> ``` Do we consider having a similar field for error message with context? If you think making `stacktrace` as an array of struct is too heavy, you can have a simpler version. -- 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
