Prometheus Exporter for Starlette 和 FastAPI

Prometheus Exporter for Starlette 和 FastAPI

starlette_exporter Prometheus exporter for Starlette and FastAPI 项目地址: https://gitcode.com/gh_mirrors/st/starlette_exporter

1. 项目介绍

starlette_exporter 是一个用于Starlette和FastAPI应用的开源Prometheus指标导出器。它收集基本的指标，如请求总数、请求持续时间直方图、以及正在处理的并发请求数。这些指标带有HTTP方法、路径和响应状态码的标签，可以帮助开发者监控和优化应用性能。

2. 项目快速启动

以下是如何在Starlette或FastAPI项目中集成 starlette_exporter 的步骤：

安装

首先，确保已经安装了 starlette_exporter。可以使用pip命令进行安装：

pip install starlette_exporter

在Starlette中集成

from starlette.applications import Starlette
from starlette_exporter import PrometheusMiddleware, handle_metrics

app = Starlette()
app.add_middleware(PrometheusMiddleware)
app.add_route("/metrics", handle_metrics)

在FastAPI中集成

from fastapi import FastAPI
from starlette_exporter import PrometheusMiddleware, handle_metrics

app = FastAPI()
app.add_middleware(PrometheusMiddleware)
app.add_route("/metrics", handle_metrics)

运行

启动你的Starlette或FastAPI应用，访问 /metrics 路由将可以看到导出的Prometheus指标。

3. 应用案例和最佳实践

添加自定义标签

你可以通过传递一个字典来为导出的指标添加自定义标签：

app.add_middleware(PrometheusMiddleware, labels={"env": "production"})

使用指标示例

如果你想为直方图观察或计数器增加跟踪ID作为示例，可以使用 exemplars 参数：

app.add_middleware(PrometheusMiddleware, exemplars=lambda: {"trace_id": get_trace_id})

确保你的 /metrics 路由使用 handle_openmetrics 处理器来输出包含示例的指标：

app.add_route("/metrics", handle_openmetrics)

限制指标收集

如果你想排除某些路径或HTTP方法，可以使用 skip_paths 和 skip_methods 参数：

app.add_middleware(PrometheusMiddleware, skip_paths=["/health"], skip_methods=["OPTIONS"])

4. 典型生态项目

starlette_exporter 是Starlette和FastAPI生态系统中的一部分，以下是一些相关的项目：

• Prometheus Python client：Prometheus的Python客户端库。
• Starlette：一个轻量级的ASGI框架，用于构建Web应用。
• FastAPI：一个现代、快速（高性能）的Web框架，用于构建APIs。

这些项目共同构建了一个强大的Python Web应用监控和性能分析生态系统。

starlette_exporter Prometheus exporter for Starlette and FastAPI 项目地址: https://gitcode.com/gh_mirrors/st/starlette_exporter