使用 Ruby on Rails structured event analytics 傳送並驗證事件
在受控應用程式邊界使用 Ruby on Rails structured event analytics,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Rails 請求監控
- 2
定義合約
controller_action、method 和觀測到的 status_code
- 3
在結果處發出
此訂閱者觀測 process_action.action_controller,不會為 Active Job、靜態檔案、僅經中介軟體處理的回應或整個 Rack 請求插樁。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
開始之前
- 具有寫入權限的伺服器端 TELEMETRY_API_KEY
- 將此範例放入 config/initializers/telemetry_requests.rb,每個程序註冊一次
- 提供 ActiveSupport::Notifications.monotonic_subscribe 的 Rails
交貨設定
安裝並初始化伺服器端
使用帶有伺服器端金鑰以及顯式開啟和讀取超時的小型 Net::HTTP 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Ruby on Rails structured event analytics事件
# config/initializers/telemetry_requests.rb
require "json"
require "net/http"
require "uri"
module TelemetryRailsRequests
def self.delivery_failed
warn "Telemetry request event delivery failed."
rescue StandardError
# Diagnostics must not change the application result either.
end
def self.log(fields)
key = ENV["TELEMETRY_API_KEY"]
return if key.nil? || key.empty?
uri = URI("https://api.telemetry.sh/log")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = key
request["Content-Type"] = "application/json"
request.body = { table: "api_request_completed", data: fields }.to_json
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
http.open_timeout = 1
http.read_timeout = 1
http.write_timeout = 1
http.max_retries = 0
response = http.start { |client| client.request(request) }
delivery_failed unless response.is_a?(Net::HTTPSuccess)
rescue StandardError
delivery_failed
end
end
ActiveSupport::Notifications.monotonic_subscribe(
"process_action.action_controller"
) do |_name, started, finished, _id, payload|
status = payload[:status]
status = nil unless status.is_a?(Integer) && (100..599).cover?(status)
TelemetryRailsRequests.log({
controller_action: "#{payload[:controller]}##{payload[:action]}",
method: payload[:method],
status_code: status,
status: status ? "http_#{status / 100}xx" : "unknown",
exception_observed: !!payload[:exception],
latency_ms: ((finished - started) * 1000).round(2)
})
rescue StandardError
TelemetryRailsRequests.delivery_failed
end事件結構
controller_action、method 和觀測到的 status_code
HTTP 狀態類別、exception_observed 和控制器 latency_ms
不包含請求參數、原始路徑、標頭、使用者識別碼或例外訊息
檢查設定
檢查站 1
此訂閱者觀測 process_action.action_controller,不會為 Active Job、靜態檔案、僅經中介軟體處理的回應或整個 Rack 請求插樁。
檢查站 2
HTTP 狀態類別描述觀測到的控制器回應,不代表業務成功或已送達使用者。缺少的狀態保留為未知。
檢查站 3
延遲採用控制器通知的單調時鐘間隔,不包含此訂閱者的 HTTP 匯出時間。
檢查站 4
匯出同步執行且盡力而為,連線、讀取和寫入逾時均為一秒。這些通訊端逾時並非嚴格的總時限;傳送會增加請求延遲。
檢查站 5
傳輸、非 2xx 回應、編碼和診斷失敗均被隔離,不取代控制器結果或原始例外。缺少金鑰時跳過匯出。
檢查站 6
此範例沒有佇列、持久投遞、匯出重試或關閉時排空機制。若不能接受事件遺失,請使用應用程式自行管理的寄件匣。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。
Ruby on Rails structured event analytics 驗證查詢
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。
在哪裡記錄事件
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID,所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件結構描述範例
此工作流程的事件結構描述
在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 儀表板
將經過驗證的產品或收入查詢轉變為集中的決策介面。
相關 SQL 查詢範例
更多 SQL 範例
針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。
與此整合配對的範本
更多整合