使用 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 延遲
哪些下游依賴項的尾部延遲和故障率最差？
開啟查詢範例按客戶影響對錯誤指紋進行排名
哪些錯誤組影響最多的客戶帳戶？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合