MongoDB Operation Telemetry:從邊界到驗證行
在受控應用程式邊界使用 MongoDB Operation Telemetry,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
慢執行分析
- 2
定義合約
database_system、操作、collection_name、query_fingerprint、釋放
- 3
埋點邊界
將應用程式操作與資料庫命令分開命名,以便儀表板在查詢實現發生變化時保持穩定。
- 4
核實證據
Exercise a known fixture, then inspect mongodb_operation_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- MongoDB Node.js 驅動程式和 telemetry-sh 初始化伺服器端
- 不包括集合文件或過濾器值的有界操作分類法
- 應用程式計時和資料庫分析器診斷之間的區別回顧
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
MongoDB Operation Telemetry事件
await telemetry.log("mongodb_operation_completed", {
database_system: "mongodb",
operation: "workspace_activity.aggregate",
collection_name: "workspace_activity",
query_fingerprint: "workspace_activity_summary_v3",
status: "success",
duration_ms: Math.round(performance.now() - startedAt),
result_count: results.length,
retry_count: 0,
transaction_status: "not_started",
read_preference: "primaryPreferred",
route_template: "/api/workspaces/:workspaceId/activity",
release: process.env.APP_RELEASE,
});活動合約
database_system、操作、collection_name、query_fingerprint、釋放
狀態、duration_ms、result_count、retry_count 和 transaction_status
read_preference、write_concern_category、route_template 和 error_type
實施檢查點
檢查站 1
將應用程式操作與資料庫命令分開命名,以便儀表板在查詢實現發生變化時保持穩定。
檢查站 2
將過濾器、更新文件、聚合管道、返回文件、連線字串和不受限制的驅動程式錯誤排除在事件之外。
檢查站 3
有選擇地使用 MongoDB 資料庫分析器進行本機查詢診斷;其捕獲的資料可能包括敏感的查詢詳細資訊,並且需要自己的存取和保留審查。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。
MongoDB Operation Telemetry 驗證查詢
SELECT *
FROM mongodb_operation_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID,所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 SQL 查詢 API
對結構化事件資料表執行只讀 DataFusion SQL 並重用結果。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。
透過指紋查詢緩慢的資料庫查詢
哪些資料庫操作始終慢到足以進行調查?
開啟查詢範例按總時間影響對資料庫查詢進行排名
哪個資料庫操作消耗的累積請求時間最多?
開啟查詢範例計算資料庫事務回滾率
哪些服務回滾了異常份額的資料庫事務?
開啟查詢範例測量長時間執行的資料庫事務
哪些應用程式事務類別保持開放時間最長?
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合