Skip to content

[SPARK-50427][CONNECT][PYTHON] Expose configure_logging as a public API #48802

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
nija-at wants to merge 3 commits into from
Closed

[SPARK-50427][CONNECT][PYTHON] Expose configure_logging as a public API #48802

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de3ec77
expose configure_logging
nija-at Nov 8, 2024
64350c5
adjust
nija-at Nov 26, 2024
6eba5ad
lint
nija-at Nov 26, 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
22 changes: 14 additions & 8 deletions python/pyspark/sql/connect/logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,36 @@
import os
from typing import Optional

__all__ = [
"getLogLevel",
]
__all__ = ["configureLogging", "getLogLevel"]


def _configure_logging() -> logging.Logger:
"""Configure logging for the Spark Connect clients."""
def configureLogging(level: Optional[str] = None) -> logging.Logger:
"""
Configure log level for Spark Connect components.
When not specified as a parameter, log level will be configured based on
the SPARK_CONNECT_LOG_LEVEL environment variable.
When both are absent, logging is disabled.

.. versionadded:: 4.0.0
"""
logger = PySparkLogger.getLogger(__name__)
handler = logging.StreamHandler()
handler.setFormatter(
logging.Formatter(fmt="%(asctime)s %(process)d %(levelname)s %(funcName)s %(message)s")
)
logger.addHandler(handler)

# Check the environment variables for log levels:
if "SPARK_CONNECT_LOG_LEVEL" in os.environ:
if level is not None:
logger.setLevel(level.upper())
elif "SPARK_CONNECT_LOG_LEVEL" in os.environ:
logger.setLevel(os.environ["SPARK_CONNECT_LOG_LEVEL"].upper())
else:
logger.disabled = True
return logger


# Instantiate the logger based on the environment configuration.
logger = _configure_logging()
logger = configureLogging()


def getLogLevel() -> Optional[int]:
Expand Down