在 Python 日志记录中向每条日志消息添加信息

Question

我正在使用带有日志记录模块的Python，并且想将socket.hostname()添加到每条日志消息中，我必须在每条消息中运行此查询并且不能使用

name = socket.hostname() 

然后用名称记录格式

我正在研究这个使用日志过滤器的示例，但我这里需要的不是过滤器，而是对每个日志消息的简单操作。

我怎样才能达到想要的结果？

Answer 1

这是建立在菲利普在使用时的答案的基础上的dictConfig。本答案中演示的上下文过滤器用于psutil在每个日志消息中记录当前的 CPU 和内存使用百分比。

将此文件保存为mypackage/util/logging.py：

"""logging utiliies."""
import logging

from psutil import cpu_percent, virtual_memory


class PsutilFilter(logging.Filter):
    """psutil logging filter."""

    def filter(self, record: logging.LogRecord) -> bool:
        """Add contextual information about the currently used CPU and virtual memory percentages into the given log record."""
        record.psutil = f"c{cpu_percent():02.0f}m{virtual_memory().percent:02.0f}"  # type: ignore
        return True

请注意，过滤功能对我不起作用；只有一个过滤器类起作用。

接下来，根据此答案更新您的日志记录配置字典，如下所示：

LOGGING_CONFIG = {
    ...,
    "filters": {"psutil": {"()": "mypackage.util.logging.PsutilFilter"}},
    "handlers": {"console": {..., "filters": ["psutil"]}},
    "formatters": {
        "detailed": {
            "format": "%(asctime)s %(levelname)s %(psutil)s %(process)x:%(threadName)s:%(name)s:%(lineno)d:%(funcName)s: %(message)s"
        }
    },
}

尝试记录一些内容，并查看示例输出，例如：

2020-05-16 01:06:08,973 INFO c68m51 3c:MainThread:mypackage.mymodule:27:myfunction: This is my log message.

在上面的消息中，c68m51表示 CPU 使用率 68%，内存使用率 51%。

Answer 2

您可以使用过滤器向每条消息添加信息：

import logging
import socket

class ContextFilter(logging.Filter):
    def filter(self, record):
        record.hostname = socket.gethostname() 
        return True

if __name__ == '__main__':
    levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)-15s hostname: %(hostname)-15s : %(message)s')
    a1 = logging.getLogger('a.b.c')
    f = ContextFilter()
    a1.addFilter(f)
    a1.debug('A debug message')