Ruby on Rails Structured Event Analytics：從邊界到驗證行
在受控應用程式邊界使用 Ruby on Rails Structured Event Analytics，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Rails 請求監控
- 2
定義合約
controller_action、方法和status_code
- 3
埋點邊界
傳送列入白名單的有效負載，而不是序列化請求參數。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- 伺服器端TELEMETRY_API_KEY
- 具有顯式開啟和讀取超時的小型 HTTP 客戶端
- 標準化控制器操作或路由名稱
交貨設定
安裝並初始化伺服器端
使用帶有伺服器端金鑰以及顯式開啟和讀取超時的小型 Net::HTTP 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Ruby on Rails Structured Event Analytics事件
payload = {
table: "api_request_completed",
data: {
controller_action: "#{controller_name}##{action_name}",
method: request.method,
status_code: response.status,
status: response.server_error? ? "failed" : "success",
latency_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
request_id: request.request_id
}
}
TelemetryHttp.log(payload)活動合約
controller_action、方法和status_code
狀態、latency_ms 和 error_type
request_id、account_id，並釋放
實施檢查點
檢查站 1
傳送列入白名單的有效負載，而不是序列化請求參數。
檢查站 2
處理攝取失敗，無需列印 API 金鑰或更改已完成的客戶回應。
檢查站 3
在控制器和 Active Job 工作執行緒中使用相同的欄位型別。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Ruby on Rails Structured Event Analytics 驗證查詢
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 儀表板
將經過驗證的產品或收入查詢轉變為集中的決策介面。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
與此整合配對的範本
更多整合