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

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

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

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

Answer 2

extra关键字不是变通方法。这是编写自定义格式化程序最有说服力的方式，除非您完全编写custom logging。

format: '%(asctime).19s %(levelname)s - %(username)s: %(message)s'
logging.basicConfig(format=format)
logger.info(message, extra={'username' : request.user.username})

文档中的一些说明（**kwars for Django logger）：

传入额外字典中的键不应与日志系统使用的键冲突。

如果缺少Formatter预期的字符串，则不会记录该消息。

此功能适用于特殊情况，但并非总是如此。

Answer 3

我将提供这个问题的许多可能的完整答案之一：

Django如何使用格式化程序中的自定义属性使用日志记录？我想记录登录的用户名，例如。

其他答案涉及通过python的日志记录实用程序添加额外上下文信息的方式。使用过滤器将附加信息附加到日志记录的方法是理想的，最好在文档中进行描述：

https://docs.python.org/3/howto/logging-cookbook.html#using-filters-to-impart-contextual-information

这仍然没有告诉我们如何以通用方式从请求中获取用户。以下库执行此操作：

https://github.com/ninemoreminutes/django-crum

因此，将两者结合起来，您将对所提出的问题有一个完整的答案。

eq_statements = (item.strip() for item in many_encoded_key_values.split(','))
var_i = (var_i.split('=') for var_i in eq_statements)
my_dict = {var: int(i) for var, i in var_i}
print(my_dict)

这需要在正确安装CRUM库的Django请求 - 响应周期内进行。

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

3 个答案: