如何在Python通过Flask集成Prometheus监控API接口性能指标

夜宇君_6827

夜宇君_6827

2026-09-05

990人浏览

原创

flask应用暴露/metrics端点需用flask-prometheus-metrics等中间件自动注册,避免手写逻辑;其默认采集http_request_duration_seconds等指标,但le标签全+inf说明计时未启用,须检查enable_metrics配置、debug模式及wsgi中间件顺序。

如何在python通过flask集成prometheus监控api接口性能指标

Flask 应用没暴露 /metrics 端点?先装对库再挂中间件

直接用 prometheus_client 自己手写指标收集太重,容易漏掉请求延迟、状态码分布等关键维度。推荐用 flask-prometheus-metrics 这类轻量中间件,它自动注册 /metrics 路由并默认采集:http_request_duration_seconds、http_requests_total、http_request_size_bytes 等核心指标。

安装和初始化只需三步:

  • 运行 pip install flask-prometheus-metrics
  • 在 Flask 实例创建后立即初始化:
    from flask_prometheus_metrics import register_metrics
    app = Flask(__name__)
    register_metrics(app, app_version="1.0.0", pvc_name="my-app")
  • 确保不手动覆盖 /metrics 路由 —— 该库会自动注册,重复定义会报 AssertionError: View function mapping is overwriting an existing endpoint function

为什么 http_request_duration_seconds 的 le 标签全是 +Inf?检查是否启用了计时器

默认情况下,flask-prometheus-metrics 只在启用性能监控时才打点。如果看到直方图指标的 le(less than or equal)标签全为 +Inf,说明延迟分桶未生效,本质是中间件没真正开始计时。

原因通常有两个:

  • 调用 register_metrics() 时传了 app_config=None 或未正确读取配置,导致 ENABLE_METRICS=True 没生效
  • Flask 的 DEBUG=True 模式下,某些版本的中间件会跳过耗时统计(避免干扰调试),上线前务必确认 app.run(debug=False) 或用 gunicorn 启动
  • 自定义 WSGI 中间件顺序错误,比如把身份认证中间件放在 metrics 之前但没调用 start_time,会导致计时起点偏移

想按 API 路径(如 /api/users)或视图函数名聚合指标?得改 group_by 参数

默认指标的 path label 是原始 URL(含参数,如 /api/users/123),导致时间序列爆炸。要收敛成模板化路径(如 /api/users/{id}),不能靠 Prometheus 端 relabel —— 必须在 Flask 层统一归一化。

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载

flask-prometheus-metrics 支持通过 group_by 控制维度来源:

  • 设 group_by="endpoint":用 request.endpoint(即视图函数名),适合内部服务,label 值稳定如 user_api.get_user
  • 设 group_by="url_rule":用 request.url_rule.rule(即路由定义字符串),值为 /api/users/<user_id></user_id>,需确保所有 route 都用了变量规则而非硬编码
  • 避免用 group_by="path"(默认),尤其当接口带查询参数或动态 ID 时,cardinality 会失控

示例初始化:

register_metrics(
    app,
    group_by="url_rule",
    app_version="1.0.0"
)

本地调试时指标不更新?别忘了清除 flask.g 和线程局部存储

开发时用 app.run(debug=True, use_reloader=True),代码热重载会导致 prometheus_client 的全局 registry 被重复初始化,新旧指标混在一起,curl /metrics 可能返回重复的 http_requests_total 定义,Prometheus 抓取时报 text format parsing error。

解决方法很具体:

  • 启动前加环境变量:export PROMETHEUS_MULTIPROC_DIR=/tmp/prometheus_flask,然后用 pip install prometheus-client[multiprocess],让多进程模式接管 registry
  • 或者干脆关掉 reloader:app.run(debug=True, use_reloader=False),调试期间手动重启
  • 切勿在每次请求里调用 Counter(...).inc() —— 这会新建对象,导致指标实例泄漏,必须复用模块级定义的指标对象

最易被忽略的是:Gunicorn 多 worker 场景下,不配 PROMETHEUS_MULTIPROC_DIR 就永远抓不到准确总数 —— 每个 worker 维护独立 registry,Prometheus 只拉到其中一个的快照。

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

相关文章

数码产品性能查询
数码产品性能查询

该软件包括了市面上所有手机CPU,手机跑分情况,电脑CPU,电脑产品信息等等,方便需要大家查阅数码产品最新情况,了解产品特性,能够进行对比选择最具性价比的商品。

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4084

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23657

23

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

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

2023.08.04

2907

5

python eval
python eval

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

2023.08.04

2927

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2263

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程