如何在 Python 的日志中记录异常的 traceback 信息？

somenzz

发布于 2022-05-24 15:04:49

1K0

发布于 2022-05-24 15:04:49

文章被收录于专栏：Python七号

你好，我是征哥，写 Python 的你可能会遇到这种情况，你知道程序报错了，因为这个异常没有被捕捉，也不知道哪行代码出错了，只能手工运行一下看看哪里错了，但是，这个异常很难再次复现。

要是在日志中记录了这个异常的 traceback 信息就好了。

本文就分享一下两个方法，记录异常的 traceback 信息。

方法一：使用 logger.exception

logger.exception 方法可以将异常的 traceback 信息记录到日志里，这里有一个小小的例子：

import logging

logging.basicConfig(
    filename="./demo.log",
    level=logging.DEBUG,
    format="%(asctime)s %(levelname)s %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S",
)


def func1():
    logging.info("func1 called")
    1 / 0


def func2():
    print("func2 called")


def main():
    func1()
    func2()


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        logging.exception(f"main exception: {str(e)}")
        raise

执行该代码之后，你会在当前路径下看到 demo.log 文件，其内容如下：

这样当发生异常时，详细信息可以在日志中看到。上述代码里面用的是 logging.exception，使用 logger 也是可以的：

logger = logging.getLogger()
try:
    do_something()
except Exception as e:
    logger.exception("some message")

方法二：使用标准库 traceback

导入标准库 traceback 后，我们还可以这样来记录异常的详细信息：

import traceback

# 此处代码和方法一一样

if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        logging.error(f"main Exception: {traceback.format_exc()}")
        raise

这样，运行结果和方法一是一样的，其中 traceback.format_exc 打印的就是异常的详细信息。