ASGI Correlation ID 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00545/article/details/141513770

ASGI Correlation ID 项目教程

asgi-correlation-idRequest ID propagation for ASGI apps项目地址:https://gitcode.com/gh_mirrors/as/asgi-correlation-id

项目的目录结构及介绍

ASGI Correlation ID 项目的目录结构如下：

asgi-correlation-id/
├── github/
│   └── workflows/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── README.md
├── poetry.lock
├── pyproject.toml
└── setup.cfg

目录结构介绍

github/workflows/: 包含 GitHub Actions 的工作流配置文件。
tests/: 包含项目的测试文件。
.gitignore: 指定 Git 忽略的文件和目录。
.pre-commit-config.yaml: 配置预提交钩子。
LICENSE: 项目的许可证文件。
README.md: 项目的说明文档。
poetry.lock: 锁定依赖版本的文件。
pyproject.toml: 项目的配置文件，包含依赖和构建系统信息。
setup.cfg: 项目的配置文件，包含包的元数据和配置选项。

项目的启动文件介绍

ASGI Correlation ID 项目没有明确的“启动文件”，因为它是一个中间件库，需要集成到你的 ASGI 应用中。以下是如何在你的 FastAPI 应用中使用该中间件的示例：

from fastapi import FastAPI
from asgi_correlation_id import CorrelationIdMiddleware

app = FastAPI()
app.add_middleware(CorrelationIdMiddleware)

启动文件介绍

CorrelationIdMiddleware: 这是 ASGI Correlation ID 中间件的核心类，用于在 ASGI 应用中设置和传播相关 ID。

项目的配置文件介绍

ASGI Correlation ID 项目的配置文件主要包括 pyproject.toml 和 setup.cfg。

pyproject.toml

pyproject.toml 文件包含了项目的依赖和构建系统信息。以下是该文件的部分内容：

[tool.poetry]
name = "asgi-correlation-id"
version = "0.1.6"
description = "Middleware for setting and propagating correlation/request IDs"
authors = ["Sondre Lillebø Gundersen <sondrelg@live.no>"]
license = "BSD"

[tool.poetry.dependencies]
python = "^3.6"

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

setup.cfg

setup.cfg 文件包含了包的元数据和配置选项。以下是该文件的部分内容：

[metadata]
name = asgi-correlation-id
version = 0.1.6
description = Middleware for setting and propagating correlation/request IDs
long_description = file: README.md
long_description_content_type = text/markdown
author = Sondre Lillebø Gundersen
author_email = sondrelg@live.no
license = BSD