极客笔记python 为什么fastapi 日志输出到 stderr
1. 引言
在编写Python应用程序时，日志是非常重要的。它可以帮助我们跟踪应用程序的运行情况、调试错误和问题，并提供有关应用程序性能和行为的有用信息。因此，选择合适的日志输出位置对于开发高质量的应用程序至关重要。
FastAPI是一个高性能的Web框架，它是基于Starlette构建的。FastAPI默认将日志输出到标准错误(stderr)中。本文将探讨为什么FastAPI选择将日志信息输出到stderr，以及如何处理和定制FastAPI的日志输出。
2. 为什么将日志输出到stderr
在探讨为什么FastAPI选择将日志输出到stderr之前，先来了解一下标准错误(stderr)的概念。在Unix和类Unix系统中，标准错误是指用于输出错误消息的默认设备。它通常与标准输出(stdout)相对应，后者用于正常输出。
FastAPI选择将日志信息输出到stderr有以下几个原因：
2.1 方便调试和错误追踪
将日志输出到stderr可以方便地在控制台中查看和调试。在开发和调试过程中，我们经常需要检查日志以追踪错误和问题。通过将日志输出到stderr，可以轻松地查看和分析日志信息，而无需额外的重定向或设置。
2.2 易于集成到容器化环境
在容器化环境中，通常建议将日志信息输出到stdout和stderr。这是因为容器引擎通常将标准输出(stdout)和标准错误(stderr)捕获并记录到容器日志中。这使得我们可以将应用程序的日志与容器引擎的日志平台集成，方便管理和分析。因此，将日志输出到stderr可以更轻松地集成FastAPI应用程序到容器化环境中。
2.3 符合日志输出的最佳实践
将日志输出到stderr是一种符合日志输出最佳实践的做法。在大多数情况下，应将错误日志和警告信息输出到stderr，而将其他信息输出到stdout。这样可以方便地过滤、定向和处理不同级别的日志信息。
3. 处理FastAPI日志输出
FastAPI默认使用Python的标准库logging进行日志记录。下面是一个示例，演示如何处理FastAPI的日志输出，并将其重定向到其他位置。
import sys
import logging
from fastapi import FastAPI
# 创建FastAPI实例
app = FastAPI()
# 创建日志处理程序
log_handler = logging.StreamHandler(stream=sys.stdout)
log_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
log_handler.setFormatter(log_formatter)
# 获取FastAPI的默认日志记录器
fastapi_logger = logging.getLogger("fastapi")
fastapi_logger.propagate = False
# 添加处理程序到FastAPI的默认日志记录器
fastapi_logger.addHandler(log_handler)
# 设置日志记录级别
app.logger.setLevel(logging.INFO)
fastapi_logger.setLevel(logging.INFO)
# 输出日志
@app.get("/")
async def root():
app.logger.info("This is an info message")
app.logger.warning("This is a warning message")
return {"message": "Hello World"}
上述示例中，我们创建了一个StreamHandler实例，并将其设置为输出到sys.stdout，这样将日志输出到标准输出(stdout)中。然后，我们将该处理程序添加到FastAPI的默认日志记录器中。最后，我们设置了日志记录级别，并在根路由处理函数中输出了一些日志信息。
4. 定制FastAPI的日志输出
如果默认的日志输出方式不符合你的需求，你可以定制FastAPI的日志输出。下面是一些常见的定制方法。
4.1 输出到文件
如果你希望将日志输出到文件而不是标准错误(stderr)，可以使用FileHandler替代StreamHandler。下面是一个示例：
import logging
from fastapi import FastAPI
# 创建FastAPI实例
app = FastAPI()
# 创建日志处理程序
log_handler = logging.FileHandler("app.log")
log_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
log_handler.setFormatter(log_formatter)
# 获取FastAPI的默认日志记录器
fastapi_logger = logging.getLogger("fastapi")
fastapi_logger.propagate = False
# 添加处理程序到FastAPI的默认日志记录器
fastapi_logger.addHandler(log_handler)
# 设置日志记录级别
app.logger.setLevel(logging.INFO)
fastapi_logger.setLevel(logging.INFO)
# 输出日志
@app.get("/")
async def root():
app.logger.info("This is an info message")
app.logger.warning("This is a warning message")
return {"message": "Hello World"}
上述示例中，我们将FileHandler的实例化参数设置为要输出的文件路径。然后，我们将该处理程序添加到FastAPI的默认日志记录器中。
4.2 使用第三方日志库
如果你喜欢使用其他第三方日志库，也可以将其集成到FastAPI中。以下是一个使用loguru库的示例：
from fastapi import FastAPI
from loguru import logger
# 创建FastAPI实例
app = FastAPI()
# 输出日志
@app.get("/")
async def root():
logger.info("This is an info message")
logger.warning("This is a warning message")
return {"message": "Hello World"}
在上述示例中，我们使用loguru库的logger代替了FastAPI的默认日志记录器。你可以根据自己的喜好选择适合的第三方日志库，并使用它来处理FastAPI的日志输出。
5. 总结
本文详细介绍了为什么FastAPI选择将日志信息输出到stderr，并提供了处理和定制FastAPI日志输出的方法。通过将日志输出到stderr，我们可以方便地调试和追踪错误，轻松集成应用程序到容器化环境，并符合日志输出的最佳实践。同时，我们也提供了一些定制方法，帮助你根据自己的需求改变日志输出位置和使用第三方日志库。
当编写FastAPI应用程序时，请根据项目需求选择合适的日志输出方式，并遵循最佳实践，以帮助开发和维护高质量的应用程序。