能否在Django控制台日志中访问并自动附加请求对象信息

核心原理 #

Python 标准 logging 模块的 LogRecord 本身不会自动绑定请求维度的上下文，之前尝试找不到 request 的核心原因是：

• django.request 日志器是 Django 内置的，仅在请求返回4XX/5XX错误、请求中间件异常时才会触发日志生成，正常业务流程下的自定义模块日志，不会自动携带request对象
• 要实现全量日志自动带请求信息，不需要修改每一处日志调用，只要通过请求生命周期绑定上下文 + 日志过滤器注入字段 + 格式化配置输出的流程，就能和现有日志配置完全兼容。

落地实现步骤 #

1. 实现线程隔离的请求上下文存储 #

在请求进入时把需要的请求字段存到线程本地内存，请求结束自动清理，避免跨请求数据错乱：

# out_project/logs/context.py
import threading
# 线程本地存储，每个请求的上下文完全隔离
_request_local = threading.local()

def set_request_context(request):
    """提取需要的请求字段存入当前线程上下文"""
    _request_local.client_ip = request.META.get("REMOTE_ADDR", "")
    _request_local.user_id = getattr(request.user, "id", None) if hasattr(request, "user") else None
    _request_local.request_path = request.path
    _request_local.method = request.method
    _request_local.trace_id = request.META.get("HTTP_X_TRACE_ID", "") # 可按需扩展自定义字段

def get_request_context():
    """读取当前线程的请求上下文，无上下文时返回空默认值"""
    default_ctx = {
        "client_ip": "",
        "user_id": None,
        "request_path": "",
        "method": "",
        "trace_id": ""
    }
    for key in default_ctx:
        default_ctx[key] = getattr(_request_local, key, default_ctx[key])
    return default_ctx

def clear_request_context():
    """请求结束清理上下文，防止内存泄漏、跨请求数据串值"""
    for key in list(vars(_request_local).keys()):
        delattr(_request_local, key)

2. 新增Django请求中间件 #

把上下文存储的逻辑嵌入Django请求生命周期，所有视图执行前自动写入上下文：

# out_project/logs/middleware.py
from django.utils.deprecation import MiddlewareMixin
from out_project.logs.context import set_request_context, clear_request_context

class RequestLogContextMiddleware(MiddlewareMixin):
    def process_request(self, request):
        set_request_context(request)
    
    def process_response(self, request, response):
        clear_request_context()
        return response

注意：需要把这个中间件加到项目settings.py的MIDDLEWARE配置中，尽量放在靠前的位置，保证后续执行的视图、中间件逻辑都能取到上下文。

3. 实现日志过滤器 #

把上下文里的字段自动绑定到每一条生成的LogRecord上，不需要业务侧手动传参：

# out_project/logs/filters.py
import logging
from out_project.logs.context import get_request_context

class RequestContextFilter(logging.Filter):
    def filter(self, record):
        ctx = get_request_context()
        # 直接把字段赋值到LogRecord属性，后续格式化时可以直接用占位符引用
        record.client_ip = ctx["client_ip"]
        record.user_id = ctx["user_id"]
        record.request_path = ctx["request_path"]
        record.method = ctx["method"]
        record.trace_id = ctx["trace_id"]
        return True

4. 适配现有日志配置 #

原有LOGGING配置不需要大改，只需要新增过滤器配置、给对应handler绑定过滤器、在JSON格式化规则里新增需要输出的字段即可：

LOGGING = {
    # 原有version、disable_existing_loggers、root配置完全保留
    "version": 1,
    "disable_existing_loggers": True,
    "root": {"level": "WARNING", "handlers": ["sentry", "json_console"]},
    "formatters": {
        # 原有console格式化配置完全保留
        "console": {"datefmt": syslog_date_fmt, "format": syslog_msg_format},
        "json_fmt": {
            "()": "out_project.logs.JsonFormatter",
            "format": {
                # 原有格式化字段完全保留
                "level": "%(levelname)s",
                "hostname": "%(hostname)s",
                "name": "%(name)s",
                "where": "%(module)s.%(funcName)s",
                "stack_trace": "%(exc_text)s",
                # 新增要输出的请求字段，因为已经绑定到LogRecord上，直接用%占位即可
                "client_ip": "%(client_ip)s",
                "user_id": "%(user_id)s",
                "request_path": "%(request_path)s",
                "method": "%(method)s",
                "trace_id": "%(trace_id)s"
            },
        },
    },
    "filters": {
        # 原有filter配置完全保留
        "require_debug_false": {"()": "django.utils.log.RequireDebugFalse"},
        "file_logging": {"": ""},
        # 新增自定义的请求上下文过滤器
        "request_context": {
            "()": "out_project.logs.filters.RequestContextFilter"
        }
    },
    "handlers": {
        # 原有handler配置（null、console）完全保留
        "null": {
            "level": "DEBUG",
            "class": "logging.NullHandler",
        },
        "console": {
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "console",
        },
        # 给sentry handler绑定请求过滤器，上报的错误也会自动带请求信息
        "sentry": {
            "level": "WARNING",
            "class": "raven.contrib.django.raven_compat.handlers.SentryHandler",
            "filters": ["request_context"]
        },
        # 给json_console handler绑定请求过滤器
        "json_console": {
            "level": "INFO",
            "class": "logging.StreamHandler",
            "formatter": "json_fmt",
            "filters": ["request_context"]
        },
    },
    # 原有loggers配置完全保留，不需要改动
    "loggers": {
        "raven": {
            "level": "INFO",
            "handlers": ["json_console"],
            "propagate": False,
        },
        "sentry.errors": {
            "level": "INFO",
            "handlers": ["json_console"],
            "propagate": False,
        },
        "out_project": {
            "level": "INFO",
            "propagate": True,
        },
    },
}

关键说明 #

• 所有现有业务代码的日志调用完全不需要修改，原来写的MODULE_LOGGER.warning("log me!")会自动经过过滤器，携带当前请求的上下文信息
• 如果项目是ASGI异步架构，线程本地存储不再适用，需要把上下文存储替换为contextvars实现，适配async/await的执行模型
• 原有django.request日志器不需要额外配置，它生成的日志同样会经过同一套handler和过滤器，自动带上请求字段

内容的提问来源于stack exchange，提问作者Charklewis