如何将自定义字段添加到Python日志格式字符串中？

Question

我当前的格式字符串是：

formatter = logging.Formatter('%(asctime)s : %(message)s')

我想添加一个名为app_name的新字段，它在包含此格式化程序的每个脚本中都有不同的值。

import logging
formatter = logging.Formatter('%(asctime)s %(app_name)s : %(message)s')
syslog.setFormatter(formatter)
logger.addHandler(syslog)

但我不确定如何将该app_name值传递给记录器以插入到格式字符串中。很明显，我可以让它出现在日志消息中，但每次都会传递它，但这很混乱。

我试过：

logging.info('Log message', app_name='myapp')
logging.info('Log message', {'app_name', 'myapp'})
logging.info('Log message', 'myapp')

但没用。

Answer 1

您需要将dict作为参数传递给extra才能这样做。

logging.info('Log message', extra={'app_name': 'myapp'})

证明：

>>> import logging
>>> logging.basicConfig(format="%(foo)s - %(message)s")
>>> logging.warning('test', extra={'foo': 'bar'})
bar - test 

另外，需要注意的是，如果您尝试在不传递dict的情况下记录消息，那么它将失败。

>>> logging.warning('test')
Traceback (most recent call last):
  File "/usr/lib/python2.7/logging/__init__.py", line 846, in emit
    msg = self.format(record)
  File "/usr/lib/python2.7/logging/__init__.py", line 723, in format
    return fmt.format(record)
  File "/usr/lib/python2.7/logging/__init__.py", line 467, in format
    s = self._fmt % record.__dict__
KeyError: 'foo'
Logged from file <stdin>, line 1