logging.warn() 添加堆栈跟踪

Question

我今天正在处理的遗留代码库中有几个 logging.warn('....') 调用。

我想更好地理解日志输出。到目前为止，logging.warn() 确实发出了一行。但是这一行还不足以理解上下文。

我想查看解释器的堆栈跟踪。

由于我的代码中有很多 logging.warn('....') 行，我想保留它们原样，只修改日志的配置。

如何将解释器堆栈跟踪自动添加到每个warn() 或error() 调用？

我知道logging.exception("message") 显示堆栈跟踪，但我想保持logging.warn() 行不变。

Answer 1

如果您接受添加日志处理程序，这很简单：

import logging
import traceback


class WarnWithStackHandler(logging.StreamHandler):
    def emit(self, record):
        if record.levelno == logging.WARNING:
            stack = traceback.extract_stack()
            # skip logging internal stacks
            stack = stack[:-7]
            for line in traceback.format_list(stack):
                print(line, end='')
        super().emit(record)

Answer 2

我不认为处理程序是您的解决方案。去过滤器：

import os.path
import traceback
import logging
_LOGGING_FILE = os.path.normcase(logging.addLevelName.__code__.co_filename)
_CURRENT_FILE = os.path.normcase(__file__)
_ELIMINATE_STACK = (_CURRENT_FILE, _LOGGING_FILE)


class AddStackFilter(logging.Filter):
    def __init__(self, levels=None):
        self.levels = levels or set()

    def get_stack(self):
        # Iterator over file names
        filenames = iter(_ELIMINATE_STACK)
        filename = next(filenames, "")
        frames = traceback.walk_stack(None)

        # Walk up the frames
        for frame, lineno in frames:

            # If frame is not from file, continue on to the next file
            while os.path.normcase(frame.f_code.co_filename) != filename:
                filename = next(filenames, None)
                if filename is None:
                    break
            else:
                # It's from the given file, go up a frame
                continue

            # Finished iterating over all files
            break

        # No frames left
        else:
            return None

        info = traceback.format_stack(frame)
        info.insert(0, 'Stack (most recent call last):\n')

        # Remove last newline
        info[-1] = info[-1].rstrip()

        return "".join(info)

    def filter(self, record):
        if record.levelno in self.levels:
            sinfo = self.get_stack()
            if sinfo is not None:
                record.stack_info = sinfo

        return True

这个过滤器有很多优点：

1. 从本地文件和日志文件中删除堆栈帧。
2. 保留堆栈帧以防我们在通过日志记录后返回到本地文件。如果我们希望将相同的模块用于其他内容，这一点很重要。
3. 您可以将其附加到任何处理程序或记录器，不会将您绑定到 StreamHandler 或任何其他处理程序。
4. 您可以使用同一个过滤器影响多个处理程序，也可以选择一个处理程序。
5. 级别以__init__ 变量的形式给出，允许您根据需要添加更多级别。
6. 允许您将堆栈跟踪添加到日志中，而不仅仅是打印。
7. 与日志记录模块配合得很好，将堆栈放置在正确的位置，没有任何意外。

用法：

>>> import stackfilter
>>> import logging
>>> sfilter = stackfilter.AddStackFilter(levels={logging.WARNING})
>>> logging.basicConfig()
>>> logging.getLogger().addFilter(sfilter)
>>> def testy():
...     logging.warning("asdasd")
...
>>> testy()
WARNING:root:asdasd
Stack (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in testy

Answer 3

@Martijn Pieters♦ 在 cmets 中给出了我正在寻找的答案

在 python 3.x 中

logger.warning(f'{error_message}', stack_info=True)

完全满足您的需要。

感谢@Martijn Pieters♦