Django日志器传递多参数并在格式器中直接使用的实现方法

实现思路 #

Python标准日志模块中，logger.warning()、logger.exception()等方法接收的位置参数会被存入日志记录对象（LogRecord）的args元组中。默认格式器无法直接通过%(arg1)s这类命名字段访问这些参数，我们可以通过**自定义日志过滤器（Filter）**将args元组中的元素映射为LogRecord的命名属性，从而在格式器中直接调用。

具体实现 #

1. 自定义日志过滤器 #

创建过滤器类，负责把args中的位置参数转换成LogRecord的命名属性：

import logging

class CustomArgFilter(logging.Filter):
    def filter(self, record):
        # 将位置参数映射为命名属性
        if isinstance(record.args, tuple) and len(record.args) > 0:
            # 这里假设最多处理2个参数，可根据需求扩展
            record.arg1 = record.args[0] if len(record.args) >= 1 else ""
            record.arg2 = record.args[1] if len(record.args) >= 2 else ""
            
            # 清空args避免日志消息被自动格式化（不需要的话可删除此行）
            record.args = ()
        return True

2. 配置Django日志 #

在项目settings.py中配置日志，注册自定义过滤器和目标格式器：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        # 注册自定义过滤器，替换为你的实际路径
        'custom_arg_filter': {
            '()': 'myapp.utils.CustomArgFilter',
        },
    },
    'formatters': {
        # 定义包含命名参数的格式字符串
        'custom_formatter': {
            'format': '[%(asctime)s] %(levelname)s|%(name)s|0|0|%(message)s|%(arg1)s|%(arg2)s',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'filters': ['custom_arg_filter'],  # 应用过滤器
            'formatter': 'custom_formatter',
        },
        # 可添加文件handler并同样应用过滤器
        'file': {
            'class': 'logging.FileHandler',
            'filename': '/var/log/myapp.log',
            'filters': ['custom_arg_filter'],
            'formatter': 'custom_formatter',
        },
    },
    'loggers': {
        # 给目标logger绑定handler
        'myapp': {
            'handlers': ['console', 'file'],
            'level': 'DEBUG',
            'propagate': False,
        },
    },
}

3. 调用日志方法 #

直接按你的需求调用日志接口即可：

import logging

logger = logging.getLogger('myapp')

# 普通警告日志
logger.warning('用户操作异常', '操作ID:123', '用户ID:456')

# 异常日志
try:
    raise ValueError('无效参数')
except Exception as e:
    logger.exception('处理请求时出错', '请求路径:/api/test', '参数:{"id":789}')

注意事项 #

• 若需要支持更多参数，可在过滤器中扩展逻辑（如添加arg3、arg4等）。
• 若偶尔需要使用日志消息的格式化功能（即msg中包含%s占位符），可删除过滤器中record.args = ()这一行，但要注意参数顺序与占位符的对应关系。
• 过滤器绑定到handler层面，只有配置了该过滤器的handler才会处理参数映射。

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