终极指南：如何用Prometheus Python Client实现Web应用监控—

终极指南：如何用Prometheus Python Client实现Web应用监控——Flask、FastAPI实战教程

【免费下载链接】client_pythonPrometheus instrumentation library for Python applications项目地址: https://gitcode.com/gh_mirrors/cl/client_python

Prometheus Python Client是一款强大的Prometheus instrumentation库，专为Python应用设计，能够帮助开发者轻松实现Web应用的性能监控和指标收集。本文将以Flask和FastAPI这两种流行的Python Web框架为例，详细介绍如何快速集成Prometheus监控，让你在5分钟内就能搭建起专业的应用监控系统。

为什么选择Prometheus Python Client？

在现代Web应用开发中，实时监控系统健康状态和性能指标至关重要。Prometheus Python Client作为GitHub加速计划中的重要项目（项目路径：gh_mirrors/cl/client_python），提供了简单易用的API，让开发者能够轻松地在Python应用中嵌入监控功能。

图：Prometheus文档主题界面展示了清晰的监控指标分类和直观的数据展示方式

快速安装Prometheus Python Client

开始使用前，你需要通过pip安装Prometheus Python Client库：

pip install prometheus-client

如果你需要从源码安装，可以克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/cl/client_python cd client_python pip install .

Flask应用监控实现步骤

基础集成：5行代码添加/metrics端点

Flask应用集成Prometheus监控非常简单，只需使用WSGI中间件将/metrics端点添加到你的应用中。创建一个myapp.py文件，添加以下代码：

from flask import Flask from werkzeug.middleware.dispatcher import DispatcherMiddleware from prometheus_client import make_wsgi_app # 创建Flask应用 app = Flask(__name__) # 添加Prometheus WSGI中间件，路由/metrics请求 app.wsgi_app = DispatcherMiddleware(app.wsgi_app, { '/metrics': make_wsgi_app() })

运行与访问监控指标

安装uWSGI并启动应用：

pip install uwsgi uwsgi --http 127.0.0.1:8000 --wsgi-file myapp.py --callable app

现在访问 http://localhost:8000/metrics 即可查看自动收集的应用指标。

FastAPI应用监控实现步骤

基础集成：ASGI方式挂载/metrics

对于FastAPI应用，我们使用ASGI方式集成Prometheus监控。创建myapp.py文件：

from fastapi import FastAPI from prometheus_client import make_asgi_app # 创建FastAPI应用 app = FastAPI(debug=False) # 添加Prometheus ASGI中间件，挂载/metrics端点 metrics_app = make_asgi_app() app.mount("/metrics", metrics_app)

多进程部署支持

当使用Gunicorn多进程部署时，需要使用多进程收集器。修改代码如下：

from fastapi import FastAPI from prometheus_client import make_asgi_app, CollectorRegistry from prometheus_client.multiprocess import MultiProcessCollector app = FastAPI(debug=False) # 使用多进程收集器 def make_metrics_app(): registry = CollectorRegistry() MultiProcessCollector(registry) return make_asgi_app(registry=registry) metrics_app = make_metrics_app() app.mount("/metrics", metrics_app)

使用Gunicorn启动应用

pip install gunicorn uvicorn gunicorn -b 127.0.0.1:8000 myapp:app -k uvicorn.workers.UvicornWorker

添加--workers n参数可以指定工作进程数量，例如--workers 4。

核心监控指标解析

Prometheus Python Client自动收集多种核心指标，包括：

请求次数：通过http_requests_total指标跟踪
响应时间：通过http_request_duration_seconds直方图记录
内存使用：process_resident_memory_bytes指标展示
CPU使用率：process_cpu_seconds_total提供CPU时间统计

这些指标可以直接用于Prometheus告警规则配置和Grafana可视化面板创建。

高级应用：自定义业务指标

除了自动收集的指标外，你还可以定义业务相关的自定义指标。例如，添加一个计数器来跟踪特定API的调用次数：

from prometheus_client import Counter # 定义自定义计数器 api_requests = Counter('api_requests_total', 'Total number of API requests', ['endpoint']) # 在路由中使用 @app.get("/api/data") def get_data(): api_requests.labels(endpoint="/api/data").inc() return {"data": "sample"}