Pino Structured Event Analytics：從邊界到驗證行
在受控應用程式邊界使用 Pino Structured Event Analytics，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Node.js API可靠性
- 2
定義合約
request_id、route_template、方法、status_code 和狀態
- 3
埋點邊界
保留 Pino 作為詳細診斷流；僅當請求或工作流程到達最終結果時，才會發出單獨的緊湊 Telemetry 行。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- Pino 和 telemetry-sh 在受信任的 Node.js 執行時初始化一次
- 穩定的路由範本、工作流程名稱、請求 ID 和發布識別符號
- 針對憑證和私人內容的欄位白名單和 Pino 編輯規則
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Pino Structured Event Analytics事件
import pino from "pino";
import telemetry from "telemetry-sh";
const logger = pino();
const startedAt = performance.now();
try {
const result = await runCheckout();
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 200,
status: "success",
latency_ms: Math.round(performance.now() - startedAt),
release: process.env.APP_RELEASE,
};
logger.info(outcome, "checkout completed");
await telemetry.log("api_request_completed", outcome);
return result;
} catch (error) {
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 500,
status: "failed",
latency_ms: Math.round(performance.now() - startedAt),
error_type: classifyError(error),
release: process.env.APP_RELEASE,
};
logger.error({ ...outcome, err: error }, "checkout failed");
await telemetry.log("api_request_completed", outcome);
throw error;
}活動合約
request_id、route_template、方法、status_code 和狀態
latency_ms、error_type、發布、環境和服務
account_id 或 tenant_id 僅在批准進行操作分析時
實施檢查點
檢查站 1
保留 Pino 作為詳細診斷流；僅當請求或工作流程到達最終結果時，才會發出單獨的緊湊 Telemetry 行。
檢查站 2
在系統之間共享批准的 request_id 以進行關聯，但不要將日誌訊息、請求正文、標頭或異常堆疊複製到事件中。
檢查站 3
在應用程式邊界等待或以其他方式解釋 Telemetry 承諾，如果丟失結果是不可接受的，則定義發件箱策略。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Pino Structured Event Analytics 驗證查詢
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 錯誤或尾部延遲？
開啟查詢範例按客戶影響對錯誤指紋進行排名
哪些錯誤組影響最多的客戶帳戶？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合