Loguru项目中获取格式化异常堆栈的技术实现

背景介绍

Loguru是一个Python日志库，以其简单易用和强大的功能受到开发者欢迎。在实际应用中，我们经常需要将日志信息序列化为JSON格式，以便于后续处理和存储。然而，Loguru默认提供的异常堆栈信息格式较为简单，无法直接获取其内置的格式化异常堆栈。

问题分析

在日志记录过程中，特别是处理异常时，我们通常需要详细的堆栈跟踪信息。Loguru内部使用了一个名为better_exceptions的库来格式化异常输出，但官方并未提供直接获取这些格式化结果的API。

技术解决方案

基础实现

通过深入分析Loguru源码，我们发现可以通过其内部模块_better_exceptions中的ExceptionFormatter类来实现格式化异常堆栈的获取：

from loguru._better_exceptions import ExceptionFormatter

def get_formatted_traceback(exc_type, exc_value, exc_traceback):
    formatter = ExceptionFormatter(backtrace=True, diagnose=True)
    return '\n'.join(formatter.format_exception(exc_type, exc_value, exc_traceback))

完整日志序列化方案

结合Loguru的序列化功能，我们可以构建一个完整的日志处理方案：

1. 时间戳处理：使用ISO 8601格式记录精确到毫秒的时间
2. 路径信息处理：提取文件路径、模块名、函数名和行号
3. 异常处理：区分普通错误和异常情况
4. Jupyter环境适配：特殊处理Jupyter notebook中的日志记录

def serialize(record):
    # 获取时间戳
    timestamp = record["time"].isoformat(timespec='milliseconds')
    
    # 处理路径信息
    file_path = record["file"].path
    module_name = record["module"]
    function_name = record["function"]
    line_number = record["line"]
    path_info = f"{module_name}:{function_name}:{line_number}"
    
    # 处理异常信息
    error = record["exception"]
    if error:
        formatter = ExceptionFormatter(backtrace=True, diagnose=True)
        formatted_traceback = formatter.format_exception(
            error.type, error.value, error.traceback
        )
        exception = {
            "type": error.type.__name__,
            "value": str(error.value),
            "traceback": "".join(formatted_traceback),
        }
    else:
        exception = None

    # 构建日志数据结构
    log_data = {
        "time": timestamp,
        "level": record["level"].name,
        "path": path_info,
        "message": record["message"],
        "exception": exception,
    }
    
    return json.dumps(log_data)

彩色日志输出

为了提升日志可读性，我们可以为不同级别的日志添加颜色标记：

def colorize_json_string(json_str):
    # 定义颜色代码
    colors = {
        "DEBUG": "\033[36m",    # 青色
        "INFO": "\033[37m",     # 白色
        "WARNING": "\033[33m",  # 黄色
        "ERROR": "\033[31m",    # 红色
        "CRITICAL": "\033[37;41m" # 白字红底
    }
    
    # 根据日志级别应用不同颜色
    level_match = re.search(r'"level": "([^"]+)"', json_str)
    if level_match:
        level = level_match.group(1)
        color = colors.get(level, "\033[0m")
        json_str = re.sub(
            r'("message": ")(.*?)(")', 
            rf'\1{color}\2\033[0m\3', 
            json_str
        )
    
    return json_str

实际应用

将上述组件整合到Loguru日志记录器中：

def configure_logger():
    logger.remove()
    
    def serialize_record(record):
        record["extra"]["serialized"] = colorize_json_string(serialize(record))
    
    logger.patch(serialize_record)
    logger.add(
        sys.stderr,
        format="{extra[serialized]}",
        backtrace=True,
        diagnose=True
    )
    
    return logger

技术要点总结

1. 异常堆栈格式化：通过Loguru内部API获取格式化的异常堆栈信息
2. 结构化日志：将日志信息转换为结构化的JSON格式
3. 环境适配：特殊处理Jupyter notebook等特殊环境
4. 可视化增强：为不同级别的日志添加颜色标记，提升可读性
5. 性能考虑：仅在需要时格式化异常堆栈，避免不必要的性能开销

注意事项

1. 使用内部API(_better_exceptions)可能存在版本兼容性问题
2. 彩色输出在部分终端可能无法正常显示
3. 在生产环境中应考虑关闭diagnose选项以避免敏感信息泄露
4. 序列化大量日志时应注意性能影响

这种实现方式既保留了Loguru的简洁性，又提供了强大的日志处理能力，特别适合需要结构化日志和详细异常信息的应用场景。