logging日志改造---自定义参数传递到格式中

最新推荐文章于 2024-04-28 10:08:13 发布

原创最新推荐文章于 2024-04-28 10:08:13 发布 · 460 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#python

python 专栏收录该内容

48 篇文章

订阅专栏

文章介绍了如何在Python的日志记录中添加自定义参数，并通过Logger类实现。讨论了现有代码的问题，即定位到错误代码位置的问题，以及提供了一个解决方案，即通过修改调用链获取更精确的上下文信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一：需求

需求：将自定义的参数，放在日志的指定格式中。

二：实现方式

例如：让debug， info，warning，error函数都允许传递一个trace_id, 并将这个trace_id输出到我们自定义日志指定的格式中。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time   : 2023/10/19 10:08
# @Author : shanwen.ren
import logging
import inspect
import logging.config

self_logger = logging.getLogger("debug")


class Logger(logging.Logger):

    @staticmethod
    def check_trace_id(kwargs):
        """kwargs mush has trace_id and trace_id value type mush is str."""
        trace_id = str(kwargs.get("trace_id", ""))
        if "extra" not in kwargs:
            extra = {"trace_id": trace_id}
        else:
            assert isinstance(kwargs["extra"], dict)
            extra = kwargs["extra"]
            extra.update({"trace_id": trace_id})

        if "trace_id" in kwargs.keys():
            kwargs.pop("trace_id")
        return extra, kwargs

    def debug(self, msg, *args, **kwargs):
        extra, kwargs = self.check_trace_id(kwargs)
        self_logger.debug(msg, *args, extra=extra, **kwargs)

    def info(self, msg, *args, **kwargs):
        extra, kwargs = self.check_trace_id(kwargs)
        self_logger.info(msg, *args, extra=extra, **kwargs)

    def warning(self, msg, *args, **kwargs):
        extra, kwargs = self.check_trace_id(kwargs)
        self_logger.warning(msg, *args, extra=extra, **kwargs)

    def error(self, msg, *args, **kwargs):
        extra, kwargs = self.check_trace_id(kwargs)
        self_logger.error(msg, *args, extra=extra, **kwargs)


logger = Logger()


def init_log(log_path, log_name, log_level="DEBUG"):
    log_level = log_level.upper()
    LOG_PATH_DEBUG = "%s/%s.log" % (log_path, log_name)
    LOG_FILE_BACKUP_COUNT = 10

    log_conf = {
        "version": 1,
        "formatters": {
            "format1": {
                "format": '|%(asctime)s.%(msecs)03d|%(levelname)s|%(trace_id)s|%(thread)d|%(filename)s %(lineno)d|%(message)s',
                "datefmt": '%Y-%m-%d %H:%M:%S',
            },
        },

        "handlers": {
            "handler": {
                "class": "logging.handlers.TimedRotatingFileHandler",
                "level": log_level,
                "formatter": "format1",
                "when": "midnight",
                "backupCount": LOG_FILE_BACKUP_COUNT,
                "filename": LOG_PATH_DEBUG
            },
        },

        "loggers": {
            "debug": {
                "handlers": ["handler"],
                "level": log_level
            },
        }
    }
    logging.config.dictConfig(log_conf)


def close_log():
    logging.shutdown()