nonebot2/website/versioned_docs/version-2.0.0/appendices/log.md
noneflow[bot] 8dcfe92f13 🔖 Release 2.0.0
2023-06-01 06:26:07 +00:00

3.4 KiB
Raw Blame History

sidebar_position description options
6 记录与控制日志
menu
weight category
70 appendices

日志

无论是在开发还是在生产环境中,日志都是一个重要的功能,可以帮助我们了解运行状况、排查问题等。虽然我们可以使用 print 来将需要的信息输出到控制台但是这种方式难以控制而且不利于日志的归档、分析等。NoneBot 使用优秀的 Loguru 库来进行日志记录。

记录日志

我们可以从 NoneBot 中导入 logger 对象,然后使用 logger 对象的方法来记录日志。

from nonebot import logger

logger.trace("This is a trace message")
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.success("This is a success message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

我们仅需一行代码即可记录对应级别的日志。日志可以通过配置 LOG_LEVEL 配置项来过滤输出等级,控制台中仅会输出大于等于 LOG_LEVEL 的日志。默认的 LOG_LEVELINFO,即只会输出 INFOSUCCESSWARNINGERRORCRITICAL 级别的日志。

如果需要记录 Exception traceback 日志,可以向 logger 添加 exception 选项:

try:
    1 / 0
except ZeroDivisionError:
    logger.opt(exception=True).error("ZeroDivisionError")

如果需要输出彩色日志,可以向 logger 添加 colors 选项:

logger.opt(colors=True).warning("We got a <red>BIG</red> problem")

更多日志记录方法请参考 Loguru 文档

自定义日志输出

NoneBot 在启动时会添加一个默认的日志处理器,该处理器会将日志输出到stdout,并且根据 LOG_LEVEL 配置项过滤日志等级。

默认的日志格式为:

<g>{time:MM-DD HH:mm:ss}</g> [<lvl>{level}</lvl>] <c><u>{name}</u></c> | {message}

我们可以从 nonebot.log 模块导入以使用 NoneBot 的默认格式和过滤器:

from nonebot.log import default_format, default_filter

如果需要自定义日志格式,我们需要移除 NoneBot 默认的日志处理器并添加新的日志处理器。例如,在机器人入口文件中 nonebot.init 之前添加以下内容:

from nonebot.log import logger_id

# 移除 NoneBot 默认的日志处理器
logger.remove(logger_id)
# 添加新的日志处理器
logger.add(
    sys.stdout,
    level=0,
    diagnose=True,
    format="<g>{time:MM-DD HH:mm:ss}</g> [<lvl>{level}</lvl>] <c><u>{full_name}</u></c> | {message}",
    filter=default_filter
)

如果想要输出日志到文件,我们可以使用 logger.add 方法添加文件处理器:

logger.add("error.log", level="ERROR", format=default_format, rotation="1 week")

更多日志处理器的使用方法请参考 Loguru 文档

重定向 logging 日志

logging 是 Python 标准库中的日志模块NoneBot 提供了一个 logging handler 用于将 logging 日志重定向到 loguru 处理。

from nonebot.log import LoguruHandler

# root logger 添加 LoguruHandler
logging.basicConfig(handlers=[LoguruHandler()])
# 或者为其他 logging.Logger 添加 LoguruHandler
logger.addHandler(LoguruHandler())