在FastAPI开发中,日志监控是一个至关重要的环节。它不仅能帮助我们了解应用的运行状态,还能在出现问题时迅速定位问题根源。本文将揭秘如何轻松监控FastAPI应用日志,以提升开发效率与系统稳定性。
一、FastAPI日志基础
FastAPI内置了日志系统,基于Python的
logging
模块。默认情况下,FastAPI会记录请求的路径、方法、响应时间等信息。要启用日志功能,只需在主应用文件中导入FastAPI并设置日志级别即可。
import logging
from fastapi import FastAPI
app = FastAPI()
logging.basicConfig(level=logging.INFO)
二、自定义日志格式
默认的日志格式可能无法满足我们的需求。我们可以通过自定义日志格式来展示更多有用的信息。
from logging.handlers import RotatingFileHandler
handler = RotatingFileHandler(‘app.log’, maxBytes=1024*1024*5, backupCount=2)
formatter = logging.Formatter(‘%(asctime)s – %(name)s – %(levelname)s – %(message)s’)
handler.setFormatter(formatter)
app.logger.addHandler(handler)
这样,日志文件
app.log
将包含时间、日志级别、日志名称、日志消息等信息。
三、日志级别控制
根据需求,我们可以调整日志级别,以控制日志输出的详细程度。
DEBUG
:输出所有日志,包括调试信息。
INFO
:输出所有INFO级别以上的日志。
WARNING
:输出WARNING级别以上的日志。
ERROR
:输出ERROR级别以上的日志。
CRITICAL
:输出CRITICAL级别以上的日志。
例如,要将日志级别设置为
WARNING
:
app.logger.setLevel(logging.WARNING)
四、日志输出到控制台和文件
在实际开发过程中,我们通常需要将日志输出到控制台和文件中。以下是一个同时输出到控制台和文件的示例:
import sys
console_handler = logging.StreamHandler(sys.stdout)
console_handler.setFormatter(formatter)
app.logger.addHandler(console_handler)
五、日志轮转
为了防止日志文件过大,我们可以使用
RotatingFileHandler
来实现日志轮转。
handler = RotatingFileHandler(‘app.log’, maxBytes=1024*1024*5, backupCount=2)
handler.setFormatter(formatter)
app.logger.addHandler(handler)
这样,当日志文件达到5MB时,系统会自动创建一个新的日志文件,并将旧的日志文件重命名。
六、日志监控工具
除了手动查看日志文件外,我们还可以使用一些日志监控工具来实时监控FastAPI应用的日志。
loguru
:一个轻量级的日志库,支持多种日志输出方式。
sentry
:一个开源的错误追踪平台,可以实时监控应用的错误和异常。
七、总结
通过以上方法,我们可以轻松监控FastAPI应用的日志,从而提升开发效率与系统稳定性。在实际开发过程中,根据需求调整日志格式、级别、输出方式,并使用日志监控工具,将有助于我们更好地了解应用运行状态,及时发现并解决问题。