Structlog—日志信息输出

由small_q创建，最终由small_q更新于2024-05-21 06:08 被浏览 72 用户

structlog

在bigmodule模块执行的过程中，不可避免地需要查看一些关键信息，以让我们更好地了解模块的运行状况，帮助我们进行功能调试。

因此，推荐使用structlog库，它是一个用于结构化日志记录的库，提供了一种简单而强大的方式来记录日志，使得日志更加易于解析和分析。

导入structlog

开发者无需预先安装structlog库，直接导入该库便可以使用：

import structlog

初始化日志记录器

使用structlog的第一步是初始化一个日志记录器。这可以通过调用structlog.get_logger()函数来完成：

logger = structlog.get_logger()

记录日志

一旦日志记录器被初始化，就可以使用它来记录日志了。structlog支持多种日志级别，例如：

DEBUG
INFO
WARNING
ERROR
CRITICAL

使用记录器的对应方法即可记录相应级别的日志：

logger.info("这是一个信息日志")
logger.warning("这是一个警告")
logger.error("这是一个错误")

这些日志将在模块执行的过程中被打印出来：

结构化日志

structlog的强大之处在于它支持结构化日志。这意味着可以将日志消息作为字典来传递，使得每个日志条目都可以包含丰富的数据：

logger.info("用户登录成功", user_id=123, ip_address="192.168.1.1")

这将产生如下日志：

INFO:root:user_login_success: 用户登录成功 user_id=123 ip_address=192.168.1.1

自定义日志格式

structlog允许自定义日志格式。可以使用processors来添加额外的信息到每个日志条目中。例如，可以添加当前时间戳：

from structlog.stdlib import PositionalArguments
from structlog import get_logger

logger = get_logger()
logger = logger.new(processors=[
    structlog.stdlib.ProcessorFormatter(
        processor=structlog.stdlib.add_logger_name,
        formatter=PositionalArguments()
    ),
    structlog.stdlib.ProcessorFormatter(
        processor=structlog.stdlib.add_log_level,
        formatter=PositionalArguments()
    ),
    structlog.processors.TimeStamper(fmt="%Y-%m-%d %H:%M:%S"),
    structlog.processors.StackInfoRenderer(),
    structlog.processors.FormatConverter()
])

logger.info("这是一个带时间戳的信息日志")

异常处理

在使用structlog时，可能会遇到各种异常。处理异常的最佳做法是使用try-except块来捕获并记录异常信息：

try:
    # 可能会抛出异常的代码
except Exception as e:
    logger.error("处理过程中发生错误", exc_info=True)

设置exc_info=True会将完整的异常信息包含在日志中，这对于调试非常有帮助。