引言
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，与 Starlette 和 Pydantic 集成。在开发过程中，日志是至关重要的，它可以帮助我们了解应用程序的运行情况，发现潜在的问题，并优化性能。本文将深入探讨如何配置 FastAPI 的日志，以实现高效调试与监控。
FastAPI 日志配置基础
1. 日志配置概述
FastAPI 使用 Python 的
logging
模块进行日志管理。默认情况下，FastAPI 会设置一个基本的日志配置，包括一个
StreamHandler
，它将日志输出到控制台。
2. 配置日志级别
日志级别决定了日志消息的详细程度。FastAPI 支持以下日志级别：
DEBUG：最详细的日志级别，用于跟踪程序的执行流程。
INFO：记录程序的一般运行情况。
WARNING：记录潜在的问题，但不影响程序运行。
ERROR：记录错误，可能导致程序运行中断。
CRITICAL：最严重的错误，可能影响程序正常运行。
3. 配置日志格式
日志格式定义了日志消息的显示方式。FastAPI 默认的日志格式如下：
[asctime] [levelname] [name] [message]
其中，
asctime
表示时间戳，
levelname
表示日志级别，
name
表示日志记录器名称，
message
表示日志消息内容。
高级日志配置
1. 自定义日志记录器
在某些情况下，可能需要为不同的模块或功能创建不同的日志记录器。可以通过以下方式创建自定义日志记录器：
import logging
logger = logging.getLogger(“my_logger”)
logger.setLevel(logging.DEBUG)
handler = logging.StreamHandler()
formatter = logging.Formatter(‘%(asctime)s – %(name)s – %(levelname)s – %(message)s’)
handler.setFormatter(formatter)
logger.addHandler(handler)
2. 配置日志处理器
日志处理器负责将日志消息发送到指定的目标，例如控制台、文件等。FastAPI 支持以下日志处理器：
StreamHandler
：将日志输出到控制台。
FileHandler
：将日志输出到文件。
RotatingFileHandler
：将日志输出到文件，并支持日志轮转。
以下是一个配置
FileHandler
的示例：
handler = logging.FileHandler(“app.log”)
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s – %(name)s – %(levelname)s – %(message)s’)
handler.setFormatter(formatter)
logger.addHandler(handler)
3. 配置日志轮转
RotatingFileHandler
支持日志轮转，这意味着当日志文件达到一定大小或时间时，会自动创建新的日志文件。以下是一个配置日志轮转的示例：
from logging.handlers import RotatingFileHandler
handler = RotatingFileHandler(“app.log”, maxBytes=1024*1024*5, backupCount=5)
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s – %(name)s – %(levelname)s – %(message)s’)
handler.setFormatter(formatter)
logger.addHandler(handler)
实战案例
以下是一个使用 FastAPI 和自定义日志配置的简单示例：
from fastapi import FastAPI
import logging
app = FastAPI()
# 配置日志
logger = logging.getLogger(“my_logger”)
logger.setLevel(logging.DEBUG)
handler = logging.FileHandler(“app.log”)
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s – %(name)s – %(levelname)s – %(message)s’)
handler.setFormatter(formatter)
logger.addHandler(handler)
@app.get(“/”)
async def read_root():
logger.info(“访问根路径”)
return {“Hello”: “World”}
总结
通过合理配置 FastAPI 的日志，我们可以轻松实现高效调试与监控。本文介绍了 FastAPI 日志配置的基础知识、高级配置以及实战案例，希望对您有所帮助。在开发过程中，合理利用日志，将使您的工作更加高效和便捷。