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

Question

Django 如何使用日志记录来使用格式化程序中的自定义属性进行日志记录？例如，我正在考虑记录登录的用户名。

在settings.py脚本中，定义了LOGGING变量:

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 将是当前登录的用户。也许可以在此处添加任何其他类型的 session 变量。

这里的一种解决方法是在记录器方法上使用 extra 参数，它接收一个字典，其中包含我想在格式字符串上使用的字符串作为键:

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

另一个(丑陋的)解决方法是构建消息属性以包含不属于日志格式化程序的默认属性的内容。

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

但是，有没有办法设置具有某些属性的格式字符串并让 Django 自动将它们提供给日志记录 API？例如，如果 %(username)s，request.user.username，可能是其他任何人...

Answer 1

您可以使用过滤器来添加您的自定义属性。例如:

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',
        },            
    },
    ...
}

---

通过安装过滤器，您可以处理每条日志记录并决定是否应将其从记录器传递到处理程序。

过滤器获取日志记录，其中包含日志的所有详细信息(即:时间、严重性、请求、状态码)。

格式化程序使用记录的属性将其格式化为字符串消息。如果您将自定义属性添加到该记录 - 它们也将可供格式化程序使用。