FastAPI日志优化：如何在非请求响应周期自动排除空的上下文字段（如%(ip)s）

我完全懂你的痛点——在FastAPI请求周期内，日志能完美带上客户端IP，但直接调用函数时，日志里冒出来的None实在破坏整洁性。咱们可以通过几种方式解决这个问题，这里给你推荐最灵活且易扩展的方案：

方案一：自定义日志Formatter（推荐） #

核心思路是：不再用固定的日志格式字符串，而是通过自定义Formatter类，动态判断日志记录（record）里的字段是否有效，只把有值的字段加入日志输出。

步骤1：实现自定义Formatter #

import logging

class CustomFormatter(logging.Formatter):
    # 定义需要动态添加的字段，以及对应的显示格式
    # 格式：(字段名, 字段值的格式化函数)
    dynamic_fields = [
        ("ip", lambda val: val),
        ("request_id", lambda val: f"request_id={val}"),
        ("method", lambda val: f"method={val}"),
        ("url", lambda val: f"url={val}")
    ]

    def format(self, record):
        # 初始化日志内容为消息本身
        log_components = [record.getMessage()]
        
        # 遍历所有动态字段，只添加有值的字段
        for field_name, format_func in self.dynamic_fields:
            if hasattr(record, field_name) and getattr(record, field_name) is not None:
                field_value = getattr(record, field_name)
                log_components.append(format_func(field_value))
        
        # 拼接成最终日志字符串
        return " ".join(log_components)

步骤2：替换默认的日志Formatter #

把原来的logging.basicConfig替换成以下代码，给root日志处理器绑定咱们的自定义Formatter：

logging.setLogRecordFactory(record_factory)

# 基础配置日志级别，不指定format
logging.basicConfig(level=logging.DEBUG)

# 给root日志的所有处理器设置自定义Formatter
for handler in logging.root.handlers:
    handler.setFormatter(CustomFormatter())

这样修改后：

• 在请求周期内调用my_function()，日志会输出：Hello world 127.0.0.1 method=GET url=http://127.0.0.1:8000/ request_id=xxx（根据实际请求信息变化）
• 直接调用my_function()，日志只会输出：Hello world，完全看不到None的影子。

方案二：修改Record Factory，给空字段设为空字符串 #

如果你不想自定义Formatter，也可以在record_factory里把空字段设为空字符串，这样日志格式里的%(ip)s就会显示为空，不会出现None：

def record_factory(*args, **kwargs):
    record = default_record_factory(*args, **kwargs)
    context = _logging_context.get({})
    # 空字段设为空字符串而非None
    record.request_id = context.get("request_id", "")
    record.method = context.get("method", "")
    record.ip = context.get("ip", "")
    record.url = context.get("url", "")
    return record

然后日志格式保持"%(message)s %(ip)s"，这样当没有IP时，日志会输出Hello world （末尾有个空格），虽然比None好，但还是有多余空格，所以不如方案一优雅。

为什么推荐方案一？ #

自定义Formatter的方式最灵活：你可以随意调整字段的显示顺序、格式（比如给request_id加上前缀），甚至根据不同的日志级别调整输出内容，完全不会被固定的格式字符串限制，而且能彻底避免多余的字符或None。

内容来源于stack exchange