Starlette-Prometheus 项目安装与使用教程

Starlette-Prometheus 项目安装与使用教程

starlette-prometheus 项目地址: https://gitcode.com/gh_mirrors/st/starlette-prometheus

1. 项目目录结构及介绍

Starlette-Prometheus 项目的目录结构如下：

starlette-prometheus/
├── github/
│   └── workflows/
│       └── starlette_prometheus
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── .releaserc
├── CHANGELOG.md
├── CONTRIBUTORS.md
├── LICENSE
├── README.md
├── commitlint.config.js
├── makefile
├── poetry.lock
├── pyproject.toml
├── setup.cfg

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• .releaserc: 发布配置文件。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTORS.md: 项目贡献者列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• commitlint.config.js: 提交信息格式检查配置文件。
• makefile: Makefile 文件，用于自动化任务。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: 项目配置文件，包含依赖和构建配置。
• setup.cfg: 项目配置文件，包含元数据和构建配置。

2. 项目启动文件介绍

Starlette-Prometheus 项目的主要启动文件是 README.md 文件，其中包含了项目的安装和使用说明。以下是启动文件的关键内容：

安装

$ pip install starlette-prometheus

使用示例

from starlette.applications import Starlette
from starlette_prometheus import metrics, PrometheusMiddleware

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

过滤未处理的请求路径

可以通过设置 filter_unhandled_paths=True 来过滤未处理的请求路径：

app.add_middleware(PrometheusMiddleware, filter_unhandled_paths=True)

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是项目的核心配置文件，包含了项目的依赖、构建配置等信息。以下是文件的部分内容：

[tool.poetry]
name = "starlette-prometheus"
version = "0.9.0"
description = "Prometheus integration for Starlette"
authors = ["perdy"]
license = "GPL-3.0-or-later"

[tool.poetry.dependencies]
python = "^3.8"
starlette = "^0.12"
prometheus-client = "^0.8"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

setup.cfg

setup.cfg 是项目的另一个配置文件，包含了项目的元数据和构建配置。以下是文件的部分内容：

[metadata]
name = starlette-prometheus
version = 0.9.0
description = Prometheus integration for Starlette
long_description = file: README.md
long_description_content_type = text/markdown
author = perdy
license = GPL-3.0-or-later

[options]
packages = find:
install_requires =
    starlette>=0.12
    prometheus-client>=0.8

通过以上配置文件，可以了解项目的依赖关系和构建方式。

---

以上是 Starlette-Prometheus 项目的安装与使用教程，希望对你有所帮助。

starlette-prometheus 项目地址: https://gitcode.com/gh_mirrors/st/starlette-prometheus