使用 Python and FastAPI structured logging 发送并验证事件
在受控应用程序边界使用 Python and FastAPI structured logging，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
Python API监控
- 2
定义合同
route_template、方法和status_code
- 3
在结果处发出
使用匹配的路由路径而不是原始 URL，以便标识符不会创建无界组。
- 4
核实证据
Exercise a known fixture, then inspect fastapi_response_observed for one correctly typed terminal row.
开始之前
开始之前
- 在服务环境中安装 telemetry-sh
- 使用服务器端 API 密钥初始化 TelemetryAsync
- 自行生成请求 ID，不复制不可信的请求头
交货设置
安装并初始化服务器端
使用服务器端密钥为每个进程初始化一次 Telemetry 同步代码或 TelemetryAsync 异步代码。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
pip安装
python -m pip install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Python and FastAPI structured logging事件
import asyncio
import time
import uuid
# app and the initialized TelemetryAsync client already exist.
@app.middleware("http")
async def record_request(request, call_next):
started_at = time.perf_counter()
request_id = uuid.uuid4().hex
response = await call_next(request)
route = request.scope.get("route")
latency_ms = round((time.perf_counter() - started_at) * 1000)
try:
await asyncio.wait_for(telemetry.log("fastapi_response_observed", {
"route_template": getattr(route, "path", "unmatched"),
"method": request.method,
"status_code": response.status_code,
"status": "response_observed",
"latency_ms": latency_ms,
"request_id": request_id,
}), timeout=1.0)
except Exception:
# Best effort: connect this to your existing safe diagnostics.
pass
return response事件结构
route_template、方法和status_code
响应头阶段的 status 和 latency_ms
本地生成的 request_id
检查配置
检查站 1
使用匹配的路由路径而不是原始 URL，以便标识符不会创建无界组。
检查站 2
此示例观察响应头，并不证明流式响应体完成或业务成功；latency_ms 在 call_next 返回时结束计时。
检查站 3
发送使用一秒协作式超时，并捕获错误以保留响应。生产环境仍需要有界队列和安全的失败诊断。
检查站 4
未处理的应用异常不会产生此事件。请单独检测异常处理器；请求取消仍必须向上传播。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
Python and FastAPI structured logging 验证查询
SELECT *
FROM fastapi_response_observed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
在哪里记录事件
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件模式示例
此工作流的事件模式
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
更多 SQL 示例
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
按路由计算API错误率
在至少有 20 次请求的 API 路由中，哪些路由的 5xx 错误率最高？
打开查询示例计算 p50、p95 和 p99 API 延迟
哪些端点的尾部延迟最差？
打开查询示例按路由计算API超时率
哪些 API 路由超时的频率足以影响用户？
打开查询示例比较依赖性 p95 延迟
哪些下游依赖项的尾部延迟和故障率最差？
打开查询示例按客户影响对错误指纹进行排名
哪些错误组影响最多的客户帐户？
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成