NestJS Request and Workflow Telemetry：從邊界到驗證行
在受控應用程式邊界使用 NestJS Request and Workflow Telemetry，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
NestJS API 監控
- 2
定義合約
request_id、控制器、處理程式、route_template和方法
- 3
埋點邊界
在最窄的有用範圍內應用攔截器，並從框架後設資料而不是 req.originalUrl 派生 route_template。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- telemetry-sh 在僅伺服器的 NestJS 提供程式或模組中初始化
- 避免原始 URL 和路徑識別符號的路由範本解析器
- 非阻塞與持久交付的異常分類和策略
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
NestJS Request and Workflow Telemetry事件
@Injectable()
export class OutcomeInterceptor implements NestInterceptor {
intercept(context: ExecutionContext, next: CallHandler) {
const request = context.switchToHttp().getRequest();
const response = context.switchToHttp().getResponse();
const startedAt = performance.now();
let errorType: string | undefined;
return next.handle().pipe(
catchError((error) => {
errorType = classifyError(error);
throw error;
}),
finalize(() => {
const statusCode = response.statusCode;
void telemetry.log("api_request_completed", {
request_id: request.id,
controller: context.getClass().name,
handler: context.getHandler().name,
route_template: resolveRouteTemplate(context),
method: request.method,
status_code: statusCode,
status: statusCode >= 500 ? "failed" : "success",
latency_ms: Math.round(performance.now() - startedAt),
error_type: errorType,
release: process.env.APP_RELEASE,
}).catch(recordTelemetryFailure);
}),
);
}
}活動合約
request_id、控制器、處理程式、route_template和方法
狀態、status_code、latency_ms、error_type 和發布
tenant_id、計劃或功能僅在明確批准的情況下
實施檢查點
檢查站 1
在最窄的有用範圍內應用攔截器，並從框架後設資料而不是 req.originalUrl 派生 route_template。
檢查站 2
該範例說明了交付承諾，但沒有延遲 HTTP 回應；當事件對合規性或計費至關重要時，使用應用程式擁有的發件箱。
檢查站 3
將異常物件、請求正文、授權標頭、cookie、查詢字串和原始路徑參數保留在負載之外。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
NestJS Request and Workflow Telemetry 驗證查詢
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按路由計算 API 請求吞吐量
哪些 API 路由每分鐘處理的請求最多？
開啟查詢範例按路由計算API錯誤率
哪些 API 路由具有最高的有意義 5xx 錯誤率？
開啟查詢範例計算 p50、p95 和 p99 API 延遲
哪些端點的尾部延遲最差？
開啟查詢範例按路由計算API超時率
哪些 API 路由超時的頻率足以影響使用者？
開啟查詢範例按版本比較 API 可靠性
哪些版本會出現更嚴重的 API 錯誤或尾部延遲？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合