【Python】FastAPI 配置日志即 logging 模块使用

目录

1. 日志

2. FastAPI 示例

---

1. 日志

日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为 等级 或 严重性。

日志功能应以所追踪事件级别或严重性而定。各级别适用性如下（以严重性递增）：

 

Python logging 模块 日志常用指引 — Python 3.11.3 文档作者, Vinay Sajip ,. 日志基础教程: 日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为 等级 或 严重性 。 什么时候使用日志...https://docs.python.org/zh-cn/3/howto/logging.html

2. FastAPI 示例

• main.py

from fastapi import FastAPI
import logging


app = FastAPI()

# 日志记录器
logger = logging.getLogger()

# 设置日志级别，只有大于等于这个级别的日志才能输出
logger.setLevel(logging.ERROR)

# 设置日志格式
formatter = logging.Formatter(
    "%(asctime)s - %(module)s - %(funcName)s - line:%(lineno)d - %(levelname)s - %(message)s"
)

# 输出到控制台
to_console = logging.StreamHandler()
to_console.setFormatter(formatter)
logger.addHandler(to_console)

# 输出到文件中
to_file = logging.FileHandler(filename="log.txt")
to_file.setFormatter(formatter)
logger.addHandler(to_file)


@app.get("/")
async def main():
    logger.critical("call")
    logger.error("call")
    logger.warn("call")
    logger.info("call")
    logger.debug("call")
    return {"hello": "world"}

启动：

uvicorn main:app