FastStream项目与structlog日志库的兼容性问题解析

问题背景

在FastStream项目中，当开发者尝试使用structlog作为日志记录工具时，会遇到与FastStream CLI工具的兼容性问题。这种兼容性问题主要体现在日志级别控制上，导致开发者无法同时享受structlog的强大功能和FastStream CLI的便捷特性。

问题本质

问题的核心在于structlog的BoundLogger类与Python标准库logging.Logger类在接口上的差异。FastStream CLI工具内部通过调用setLevel方法来调整日志级别，而structlog的BoundLogger类并未实现这一方法，导致运行时错误。

解决方案

要解决这个问题，我们需要采用structlog官方推荐的与标准库logging集成的方式。以下是完整的解决方案实现：

import logging.config
import structlog
from faststream import FastStream
from faststream.nats import NatsBroker

def configure_logging() -> None:
    # 定义通用处理器链
    common_processors = (
        structlog.processors.format_exc_info,
        structlog.stdlib.add_log_level,
        structlog.stdlib.add_logger_name,
        structlog.contextvars.merge_contextvars,
        structlog.stdlib.ExtraAdder(),
        structlog.dev.set_exc_info,
        structlog.processors.TimeStamper(fmt="%Y-%m-%d %H:%M:%S.%f", utc=True),
        structlog.processors.dict_tracebacks,
        structlog.processors.CallsiteParameterAdder(
            (
                structlog.processors.CallsiteParameter.FUNC_NAME,
                structlog.processors.CallsiteParameter.LINENO,
                structlog.processors.CallsiteParameter.FILENAME,
            )
        ),
    )
    
    # structlog专用处理器
    structlog_processors = (
        structlog.processors.StackInfoRenderer(),
        structlog.stdlib.PositionalArgumentsFormatter(),
        structlog.processors.UnicodeDecoder(),
        structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
    )
    
    # 日志输出处理器
    logging_console_processors = (
        structlog.stdlib.ProcessorFormatter.remove_processors_meta,
        structlog.dev.ConsoleRenderer(colors=True),
    )

    # 配置日志处理器
    handler = logging.StreamHandler()
    handler.set_name("default")
    handler.setLevel(logging.INFO)
    console_formatter = structlog.stdlib.ProcessorFormatter(
        foreign_pre_chain=common_processors,
        processors=logging_console_processors,
    )
    handler.setFormatter(console_formatter)

    # 应用日志配置
    logging.basicConfig(handlers=[handler], level=logging.INFO)
    structlog.configure(
        processors=common_processors + structlog_processors,
        logger_factory=structlog.stdlib.LoggerFactory(),
        wrapper_class=structlog.stdlib.BoundLogger,
        cache_logger_on_first_use=True,
    )

# 获取标准库logger实例
logger = logging.getLogger(__name__)

def app() -> FastStream:
    configure_logging()
    broker = NatsBroker(logger=logger)
    return FastStream(broker, logger=logger)

实现原理

这个解决方案的关键点在于：

1. 双重日志系统架构：通过structlog.stdlib模块将structlog与Python标准库logging系统桥接起来。

2. 处理器链分离：将日志处理分为预处理阶段(structlog)和输出阶段(logging)，保持各自优势。

3. 标准库兼容性：最终使用的是标准库的Logger实例，确保与FastStream CLI工具完全兼容。

4. 丰富的日志信息：通过配置多个处理器，保留了structlog强大的上下文处理和结构化日志能力。

最佳实践建议

1. 在FastStream项目中，推荐始终使用这种集成方式配置structlog。

2. 日志级别控制应通过标准库logging接口实现，确保与各种工具兼容。

3. 可以根据项目需求调整处理器链，增减特定的日志处理功能。

4. 对于生产环境，可以考虑添加JSON格式化处理器，便于日志分析。

通过这种方式，开发者可以同时获得structlog的强大日志处理能力和FastStream CLI工具的便捷性，实现两全其美的解决方案。