python - Django在格式化程序中记录自定义属性

Django如何使用格式化程序中的自定义属性来使用日志记录？例如，我正在考虑登录用户名。
在settings.py脚本中，定义了日志变量：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse'
        },
    },
    'formatters' : {
        'info_format' : {
            'format' : '%(asctime)s %(levelname)s - %(message)s',
        },
    }
}

我想使用一种格式，比如：

'format' : '%(asctime).19s %(levelname)s - %(username)s: %(message)s'

其中username将是当前登录的用户。也许可以在这里添加任何其他类型的会话变量。
这里的一个解决方法是使用logger方法上的extra参数，它接收一个字典，其中键作为我要在格式字符串上使用的字符串：

logger.info(message, extra={'username' : request.user.username})

另一个（丑陋的）解决方法是构建消息属性，以包含日志格式化程序默认属性之外的内容。

message = request.user.username + " - " + message
logger.info(message)

但是，有没有一种方法可以设置具有某些属性的格式字符串，并使Django自动将其提供给日志API？例如，如果%（username）s，则任何其他用户的request.user.username可能…

最佳答案

可以使用过滤器添加自定义属性。例如：

def add_my_custom_attribute(record):
    record.myAttribute = 'myValue'
    record.username = record.request.user.username
    return True

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        ...
        'add_my_custom_attribute': {
            '()': 'django.utils.log.CallbackFilter',
            'callback': add_my_custom_attribute,
        }
    },
    'handlers': {
        ...
        'django.server': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'filters': ['add_my_custom_attribute'],
            'formatter': 'django.server',
        },
    },
    ...
}

通过安装一个过滤器，您可以处理每个日志记录，并决定是否应该将其从记录器传递到处理程序。
过滤器获取包含所有日志详细信息的日志记录（即：时间、严重性、请求、状态代码）。
格式化程序使用记录的属性将其格式化为字符串消息。如果将自定义属性添加到该记录中，则格式化程序也可以使用这些属性。