如何在Python日志格式化程序中添加自定义参数？

Question

我使用标准的Python日志模块和Flask框架。我想用自定义参数-%（username）s将日志和用户操作的所有记录一起写入到文件中。格式化程序：

admin - 2013-10-11 15:11:47,033 action0
user1 - 2013-10-11 15:11:48,033 action1
user2 - 2013-10-11 15:11:49,033 action2
admin - 2013-10-11 15:11:50,033 action3

我正在使用RotatingFileHandler：

def get_user_name():
    return session.get("username", "")

file_handler = RotatingFileHandler(fname, maxBytes=1 * 1024 * 1024, backupCount=5)
file_handler.setLevel(logging.DEBUG)
file_handler.setFormatter(logging.Formatter(
    '%(username)s - %(asctime)s %(levelname)-10s %(message)s  [in %(pathname)s:%(lineno)d]'
)) # how to insert get_user_name() instead %(username)s?

app.logger.addHandler(file_handler)

做这种记录的正确方法是什么？谢谢。

Answer 1

在格式化之前，将格式化程序子类化并将自定义属性添加到日志记录中不是更简单的方法吗？

例如，我使用以下代码：

# A custom formatter to add the timestamp from the simulated clock.
class _Formatter(logging.Formatter):
  def format(self, record):
    record.simulated_clock = clock.get_time()
    return super(_Formatter, self).format(record)

# Creates a logger object.
def _create_logger():
  logger = logging.getLogger("simulation")
  logger.setLevel(kLevel)
  ch = logging.StreamHandler()
  ch.setLevel(kLevel)
  formatter = _Formatter("%(simulated_clock)s - %(levelname)s - %(message)s")
  ch.setFormatter(formatter)
  logger.addHandler(ch)

  return logger

我不认为自己是一个Python专家，但它对我很有用。。。。

Answer 2

你可以用logging.LoggerAdapter

myLogger = logging.LoggerAdapter(logging.getLogger("my-logger"), {"username" : get_user_name()})

这是您程序的完整解决方案。我使用dict构建我的配置。最好，如果你有更多的记录器

    def get_user_name():
        return session.get("username", "")

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': True,
        'formatters': {
            'my_format': {
                'format': '%(username)s - %(asctime)s %(levelname)-10s %(message)s  [in %(pathname)s:%(lineno)d]'
            },
        },
        'handlers': {
            'my_handler': {
                'level': 'DEBUG',
                'class': 'logging.handlersRotatingFileHandler',
                'filename': fname,
                'maxBytes': 1 * 1024 * 1024,
                'backupCount': 5,
            },
        },
        'loggers': {
            'my_logger': {
                'handlers': ['my_handler'],
                'propagate': True,
                'level': 'DEBUG',
            },
        } }

logging.config.dictConfig(LOGGING) 
logging.LoggerAdapter(logging.getLogger('my_logger'),
                                           {"username" : get_user_name()})