Skip to content

feat: better logger stream allocation #1006

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.

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

Merged
merged 1 commit into from
Apr 2, 2025
Merged
Changes from all commits
Commits
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
81 changes: 58 additions & 23 deletions src/codegen/shared/logging/get_logger.py
Original file line number Diff line number Diff line change
@@ -1,41 +1,76 @@
import logging
import sys

import colorlog


def get_logger(name: str, level: int = logging.INFO) -> logging.Logger:
# Force configure the root logger with a NullHandler to prevent duplicate logs
logging.basicConfig(handlers=[logging.NullHandler()], force=True)

formatter = colorlog.ColoredFormatter(
"%(white)s%(asctime)s - %(name)s - %(log_color)s%(levelname)s%(reset)s%(white)s - %(message_log_color)s%(message)s",
log_colors={
formatter = colorlog.ColoredFormatter(
"%(white)s%(asctime)s - %(name)s - %(log_color)s%(levelname)s%(reset)s%(white)s - %(message_log_color)s%(message)s",
log_colors={
"DEBUG": "white",
"INFO": "green",
"WARNING": "yellow",
"ERROR": "red",
"CRITICAL": "red,bg_white",
},
secondary_log_colors={
"message": {
"DEBUG": "cyan",
"INFO": "green",
"INFO": "white",
"WARNING": "yellow",
"ERROR": "red",
"CRITICAL": "red,bg_white",
},
secondary_log_colors={
"message": {
"DEBUG": "cyan",
"INFO": "blue",
"WARNING": "yellow",
"ERROR": "red",
"CRITICAL": "red,bg_white",
}
},
)
}
},
)


class StdOutFilter(logging.Filter):
def filter(self, record):
return record.levelno < logging.ERROR


class StdErrFilter(logging.Filter):
def filter(self, record):
return record.levelno >= logging.ERROR


# Create handlers
stdout_handler = logging.StreamHandler(sys.stdout) # Logs to stdout
stdout_handler.setFormatter(formatter)
stdout_handler.addFilter(StdOutFilter())

stderr_handler = logging.StreamHandler(sys.stderr) # Logs to stderr
stderr_handler.setFormatter(formatter)
stderr_handler.addFilter(StdErrFilter())


def get_logger(name: str, level: int = logging.INFO) -> logging.Logger:
logger = _setup_logger(name, level)
_setup_exception_logging(logger)
return logger


def _setup_logger(name: str, level: int = logging.INFO) -> logging.Logger:
# Force configure the root logger with a NullHandler to prevent duplicate logs
logging.basicConfig(handlers=[logging.NullHandler()], force=True)
logger = logging.getLogger(name)
if logger.hasHandlers():
for h in logger.handlers:
logger.removeHandler(h)

handler = colorlog.StreamHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.addHandler(stdout_handler)
logger.addHandler(stderr_handler)

# Ensure the logger propagates to the root logger
logger.propagate = True
# Set the level on the logger itself
logger.setLevel(level)
return logger


def _setup_exception_logging(logger: logging.Logger) -> None:
def log_exception(exc_type, exc_value, exc_traceback):
logger.exception("Uncaught exception", exc_info=(exc_type, exc_value, exc_traceback))

Check warning on line 73 in src/codegen/shared/logging/get_logger.py

View check run for this annotation

Codecov / codecov/patch

src/codegen/shared/logging/get_logger.py#L73

Added line #L73 was not covered by tests

# Set the log_exception function as the exception hook
sys.excepthook = log_exception