Prometheus FastAPI Instrumentator 安装与使用指南

Prometheus FastAPI Instrumentator 安装与使用指南

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

一、项目的目录结构及介绍

由于没有实际访问该项目仓库的能力，在此假设一个典型的Python开源项目的目录结构，基于常见的FastAPI与Prometheus集成项目进行推测：

• README.md: 文档根目录下的说明，提供了关于项目的主要信息，如安装步骤、如何运行示例等。
• LICENSE: 许可证文件，通常指示着项目的开放源码许可类型，比如MIT许可或GPL许可等。
• setup.py: 用于描述Python包的元数据以及设置构建和安装选项的脚本。
• pyproject.toml: 包含了工具配置和依赖关系管理的信息，有助于构建、清理和检查项目。
• src/: 主要的代码目录，包含所有实现功能的Python模块和子包。
  • init.py: 标记目录为Python包的部分，可以定义该包中哪些类或者函数应该被自动导入。
  • instrumentation.py: 可能包含了与Prometheus指标相关联的快速API框架（FastAPI）的自定义中间件逻辑。
• tests/: 测试文件所在目录，其中包括单元测试和集成测试。
• docs/: 文档目录，可能包含Sphinx或 MkDocs 等工具生成的项目文档。
• examples/ 或者 sample/ : 提供了一个或多个示例应用程序，演示了如何在实际应用中使用这个项目。

二、项目的启动文件介绍

启动文件通常是项目的入口点，对于FastAPI项目来说，这往往是一个.py文件，例如 main.py，在这个文件中，将初始化FastAPI应用实例并挂载必要的路由和中间件。

以下是一个简化版的main.py示例，它展示了一种方式来初始化FastAPI应用程序并使用Prometheus FastAPI Instrumentator:

from fastapi import FastAPI
from prometheus_fastapi_instrumentator import Instrumentator

app = FastAPI()

@app.on_event('startup')
async def startup():
    instrumentator = Instrumentator()
    # 可以添加额外参数来调整度量标准的行为
    instrumentator.instrument(app).expose(app)

这段代码的关键是Instrumentator().instrument(app).expose(app)调用，这是启动FastAPI应用程序并将Prometheus度量标准应用于它的核心部分。

三、项目的配置文件介绍

虽然Prometheus FastAPI Instrumentator本身不需要独立的配置文件来工作，但为了适应不同环境的需求（例如开发、生产），开发人员可能会创建一些配置项放在特定的配置文件中，这些配置文件可能位于config.py文件中或以更复杂的形式存在。例如，使用像pydantic.BaseSettings这样的类从环境变量读取值。

一个简单的config.py文件可能看起来像这样：

import os

class Config:
    DEBUG: bool = True if os.environ.get("DEBUG", "False").lower() == 'true' else False
    PORT: int = int(os.getenv("PORT", 8000))
    
    # Prometheus监控端口
    PROMETHEUS_PORT: int = int(os.getenv("PROMETHEUS_PORT", 9000))

# 导出配置对象以便其他地方使用
config = Config()

这种设计允许你通过环境变量轻松地切换不同的配置值，而无需修改代码。例如，在生产环境中关闭调试模式并在正确的端口上运行FastAPI服务和Prometheus监控器。

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