如何在FastAPI中集成Prometheus监控_使用python-client采集指标

P粉602998670

P粉602998670

2026-05-02

289人浏览

原创

直接用 prometheus_client.make_asgi_app() 会报 404 是因为 fastapi 不自动挂载该 asgi 应用,需显式调用 app.mount("/metrics", metrics_app);误用 include_router 或路径不以 / 开头会导致失败。

如何在fastapi中集成prometheus监控_使用python-client采集指标

为什么直接用 prometheus_clientmake_asgi_app() 会报错 404?

FastAPI 默认不自动挂载 Prometheus 的指标端点(/metrics),即使你调用了 prometheus_client.make_asgi_app(),它返回的是一个 ASGI 应用实例,但没注册进 FastAPI 的路由系统。常见现象是访问 /metrics 返回 404,或者启动时报 TypeError: object of type 'ASGIApp' has no len()——那是因为误把它当成了中间件或路由处理器直接传给了 app.mount()app.include_router()

正确做法是用 app.mount() 挂载,且路径必须以 / 开头、不能带变量或通配符:

from prometheus_client import make_asgi_app
metrics_app = make_asgi_app()
app.mount("/metrics", metrics_app)

注意:make_asgi_app() 返回的不是 FastAPI 的 APIRouter,不能用 include_router;也不能漏掉引号里的斜杠,写成 app.mount("metrics", ...) 会导致路径错位。

如何在 FastAPI 请求生命周期中自动记录 HTTP 请求延迟和状态码?

Prometheus 客户端本身不自动采集 HTTP 指标,得自己加中间件。核心是用 CounterHistogram 记录请求计数、延迟分布,并在响应返回前完成观测。

关键点:

  • Histogrambuckets 建议覆盖常见延迟范围,比如 (0.01, 0.05, 0.1, 0.25, 0.5, 1.0, 2.5, 5.0, 10.0),单位是秒
  • 标签(labelnames)至少包含 methodstatus_codepath,其中 path 要做标准化(如把 /users/123 归一为 /users/{id}),否则指标维度爆炸
  • 中间件里必须用 await call_next(request),不能丢掉 await,否则响应体可能为空或超时

示例片段(不依赖第三方库):

from prometheus_client import Counter, Histogram
from fastapi import Request, Response
import time
<p>REQUEST_COUNT = Counter(
"http_requests_total",
"Total HTTP Requests",
["method", "status_code", "path"]
)
REQUEST_LATENCY = Histogram(
"http_request_duration_seconds",
"HTTP Request Duration",
["method", "path"],
buckets=(0.01, 0.05, 0.1, 0.25, 0.5, 1.0, 2.5, 5.0, 10.0)
)</p><p>@app.middleware("http")
async def metrics_middleware(request: Request, call_next):
start_time = time.time()
try:
response = await call_next(request)
status_code = response.status_code
except Exception as e:
status_code = 500
raise e
finally:
process_time = time.time() - start_time
path = request.url.path
method = request.method</p><h1>简单路径归一化(实际建议用更健壮的路由匹配)</h1><pre class="brush:python;toolbar:false;">    if path.isdigit():
        path = "/{id}"
    elif "/user/" in path:
        path = "/user/{id}"
    REQUEST_COUNT.labels(method=method, status_code=status_code, path=path).inc()
    REQUEST_LATENCY.labels(method=method, path=path).observe(process_time)

多个 FastAPI 实例共用同一个 Prometheus registry 时要注意什么?

默认情况下 prometheus_client 使用全局 registry(REGISTRY),多进程部署(如用 uvicorn --workers 4)时,各 worker 进程会各自维护一份指标,导致 /metrics 返回的数据不一致甚至崩溃(因为并发写 registry 非线程安全)。

Python 3.14.2
Python 3.14.2

Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。

下载

解决方向只有两个:

  • prometheus-clientmultiprocess 模式:需设置环境变量 PROMETHEUS_MULTIPROC_DIR 指向一个可写的临时目录,并在应用启动前调用 prometheus_client.multiprocess.MultiProcessCollector(REGISTRY)
  • 改用单进程部署(如只开 1 个 worker),适合开发或低流量场景;但生产环境通常不推荐

注意:multiprocess 模式下,/metrics 端点必须用 make_wsgi_app() + WSGI server(如 Gunicorn),而 FastAPI 是 ASGI。所以目前没有开箱即用的多进程 ASGI 支持——你得自己封装一层 WSGI 兼容逻辑,或改用 starlette_exporter 这类专为 ASGI 设计的库。

为什么自定义指标在 /metrics 里查不到?

最常见原因是指标对象(GaugeCounter 等)定义在函数作用域内,每次调用都新建一个实例,导致 registry 里没注册成功;或者用了不同 registry 实例,而 make_asgi_app() 挂载的是默认 registry。

务必确保:

  • 所有指标变量定义在模块顶层(global scope),不要放在路由函数或中间件内部
  • 如果手动创建了新 registry(如 Registry()),就得显式传给 make_asgi_app(registry=my_registry)
  • 避免重复命名:同名指标(相同名称+类型)第二次注册会抛 ValueError: Duplicated timeseries in CollectorRegistry

例如,错误写法:

@app.get("/health")
def health():
    gauge = Gauge("my_custom_gauge", "A gauge")  # ❌ 每次请求都新建,不会被采集
    gauge.set(1)
    return {"status": "ok"}

正确写法:

MY_CUSTOM_GAUGE = Gauge("my_custom_gauge", "A gauge")  # ✅ 模块级定义
<p>@app.get("/health")
def health():
MY_CUSTOM_GAUGE.set(1)
return {"status": "ok"}</p>

复杂点在于指标生命周期和异步任务的协同——比如后台 Celery 任务更新的 Gauge,必须和 FastAPI 主进程共享同一 registry 实例,否则数据就断开了。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1104

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

2071

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1185

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

8797

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1479

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1550

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

881

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

530

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PyCharm官方快速入门指南
PyCharm官方快速入门指南

共0课时 | 0人学习

Python函数定义官方教程
Python函数定义官方教程

共0课时 | 0人学习

Python 3.14.6官方文档
Python 3.14.6官方文档

共0课时 | 0人学习