Winston Structured Event Analytics：從邊界到驗證行
在受控應用程式邊界使用 Winston Structured Event Analytics，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Node.js 工作流程監控
- 2
定義合約
操作、request_id 或 job_id、狀態和釋放
- 3
埋點邊界
使用 Winston 傳輸和診斷日誌格式；僅傳送定義的 Telemetry 問題所需的終端欄位。
- 4
核實證據
Exercise a known fixture, then inspect job_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- Winston 和 telemetry-sh 在伺服器或工作處理程序中初始化一次
- 穩定操作名稱、相關 ID、錯誤類別和版本
- 針對 Winston 傳輸和未完成的 Telemetry 請求的關閉策略
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Winston Structured Event Analytics事件
import winston from "winston";
import telemetry from "telemetry-sh";
const logger = winston.createLogger({
format: winston.format.json(),
transports: [new winston.transports.Console()],
});
const startedAt = performance.now();
try {
const result = await processImport();
const outcome = {
operation: "customer_import",
job_id: jobId,
status: "success",
duration_ms: Math.round(performance.now() - startedAt),
item_count: result.itemCount,
release: process.env.APP_RELEASE,
};
logger.info("customer import completed", outcome);
await telemetry.log("job_completed", outcome);
return result;
} catch (error) {
const outcome = {
operation: "customer_import",
job_id: jobId,
status: "failed",
duration_ms: Math.round(performance.now() - startedAt),
error_type: classifyError(error),
release: process.env.APP_RELEASE,
};
logger.error("customer import failed", { ...outcome, error });
await telemetry.log("job_completed", outcome);
throw error;
}活動合約
操作、request_id 或 job_id、狀態和釋放
duration_ms、error_type、retry_count 和 item_count
服務、環境、功能和批准的帳戶上下文
實施檢查點
檢查站 1
使用 Winston 傳輸和診斷日誌格式；僅傳送定義的 Telemetry 問題所需的終端欄位。
檢查站 2
不要建立轉發任意記錄的 Winston 傳輸，除非每個訊息和後設資料欄位都有經過審查的架構和編輯策略。
檢查站 3
單獨測試傳送拒絕和關閉行為，因為完成一個傳輸不會重新整理另一個網路客戶端。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Winston Structured Event Analytics 驗證查詢
SELECT *
FROM job_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合