Prometheus FastAPI Instrumentator 安装和配置指南

Prometheus FastAPI Instrumentator 安装和配置指南

prometheus-fastapi-instrumentator Instrument your FastAPI with Prometheus metrics. 项目地址: https://gitcode.com/gh_mirrors/pr/prometheus-fastapi-instrumentator

1. 项目基础介绍和主要编程语言

项目介绍

Prometheus FastAPI Instrumentator 是一个用于 FastAPI 应用的 Prometheus 指标采集工具。它可以帮助你轻松地将 Prometheus 指标集成到 FastAPI 应用中，以便监控应用的性能和行为。

主要编程语言

该项目主要使用 Python 编程语言。

2. 项目使用的关键技术和框架

关键技术

• Prometheus: 一个开源的系统监控和报警工具包。
• FastAPI: 一个现代、快速（高性能）的 Web 框架，用于构建 APIs，基于 Python 3.7+ 和异步编程。

框架

• FastAPI: 用于构建 Web 应用。
• Prometheus Client Library: 用于在 Python 应用中集成 Prometheus 指标。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装和配置之前，请确保你已经安装了以下软件：

• Python 3.7 或更高版本
• pip（Python 包管理工具）

安装步骤

步骤 1：创建虚拟环境（可选）

为了隔离项目依赖，建议创建一个虚拟环境。

python3 -m venv myenv
source myenv/bin/activate

步骤 2：安装 Prometheus FastAPI Instrumentator

使用 pip 安装 prometheus-fastapi-instrumentator 包。

pip install prometheus-fastapi-instrumentator

步骤 3：创建 FastAPI 应用

创建一个新的 FastAPI 应用文件 main.py，并添加以下代码：

from fastapi import FastAPI
from prometheus_fastapi_instrumentator import Instrumentator

app = FastAPI()

# 初始化 Instrumentator
instrumentator = Instrumentator()

# 在应用启动时进行指标暴露
@app.on_event("startup")
async def startup():
    instrumentator.instrument(app).expose(app)

# 示例路由
@app.get("/")
async def root():
    return {"message": "Hello World"}

步骤 4：运行 FastAPI 应用

使用以下命令运行 FastAPI 应用：

uvicorn main:app --reload

步骤 5：访问 Prometheus 指标

启动应用后，你可以通过访问 http://127.0.0.1:8000/metrics 来查看 Prometheus 指标。

配置步骤

自定义指标

你可以通过添加自定义指标来扩展 Prometheus 指标采集功能。例如，添加一个计数器来统计特定语言的请求次数：

from prometheus_client import Counter
from prometheus_fastapi_instrumentator import metrics

# 创建自定义指标
http_requested_languages_total = Counter(
    "http_requested_languages_total",
    "Number of times a certain language has been requested",
    labelnames=("langs",)
)

# 添加自定义指标到 Instrumentator
instrumentator.add(
    metrics.request_size(
        should_include_handler=True,
        should_include_method=False,
        should_include_status=True,
        metric_namespace="a",
        metric_subsystem="b",
    )
)

配置选项

Instrumentator 提供了多种配置选项，例如忽略特定路由、控制指标暴露等。你可以在创建 Instrumentator 实例时进行配置：

instrumentator = Instrumentator(
    should_group_status_codes=False,
    should_ignore_untemplated=True,
    should_respect_env_var=True,
    should_instrument_requests_inprogress=True,
    excluded_handlers=["/admin/*", "/metrics"],
    env_var_name="ENABLE_METRICS",
    inprogress_name="inprogress",
    inprogress_labels=True,
)

通过以上步骤，你已经成功安装并配置了 Prometheus FastAPI Instrumentator，并可以开始监控你的 FastAPI 应用了。

prometheus-fastapi-instrumentator Instrument your FastAPI with Prometheus metrics. 项目地址: https://gitcode.com/gh_mirrors/pr/prometheus-fastapi-instrumentator