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'

用户名将是当前登录的用户.也许在这里可以添加任何其他类型的会话变量.

这里的解决方法是extra在logger方法上使用该参数,该方法接收一个字典,其中键作为我想在格式字符串上使用的字符串:

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

另一个(丑陋的)解决方法是构建message属性以包含不属于记录格式化程序的默认属性的内容.

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

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

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

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