使用 Sidekiq job telemetry 傳送並驗證事件
在受控應用程式邊界使用 Sidekiq job telemetry,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Sidekiq 重試監控
- 2
定義合約
job_id、job_name、queue_name、attempt、status、duration_ms 和 release
- 3
在結果處發出
初始化檔案註冊伺服器端中介軟體。同一邏輯 jid 在 Sidekiq 重試之間維持不變;首次嘗試為 1,retry_count 為 0 表示第 2 次嘗試。無效的重試中繼資料保留為未知。
- 4
核實證據
Exercise a known fixture, then inspect job_attempt_completed for one correctly typed terminal row.
開始之前
開始之前
- 具有寫入權限的伺服器端 TELEMETRY_API_KEY
- 將此範例放入 config/initializers/telemetry_sidekiq.rb,每個工作程序載入一次
- 具有 Sidekiq::ServerMiddleware 的 Sidekiq 7 或更新版本
交貨設定
安裝並初始化伺服器端
使用帶有伺服器端金鑰以及顯式開啟和讀取超時的小型 Net::HTTP 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Sidekiq job telemetry事件
# config/initializers/telemetry_sidekiq.rb
require "sidekiq"
require "json"
require "net/http"
require "uri"
module TelemetrySidekiqAttempts
def self.delivery_failed
warn "Telemetry job event delivery failed."
rescue StandardError
# A broken diagnostic sink must not change the job outcome.
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: "job_attempt_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
class TelemetryOutcomeMiddleware
include Sidekiq::ServerMiddleware
def call(_job_instance, job, queue)
started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
status = "not_returned"
begin
result = yield
status = "returned"
result
rescue StandardError
status = "raised"
raise
ensure
begin
retry_count = job["retry_count"]
attempt = if !job.key?("retry_count")
1
elsif retry_count.is_a?(Integer) && retry_count >= 0
retry_count + 2
end
TelemetrySidekiqAttempts.log({
job_id: job["jid"],
job_name: job["class"],
queue_name: queue,
attempt: attempt,
status: status,
duration_ms: ((Process.clock_gettime(
Process::CLOCK_MONOTONIC
) - started) * 1000).round(2),
release: ENV["APP_RELEASE"]
})
rescue StandardError
TelemetrySidekiqAttempts.delivery_failed
end
end
end
end
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add TelemetryOutcomeMiddleware
end
end事件結構
job_id、job_name、queue_name、attempt、status、duration_ms 和 release
不包含工作參數、結果內容、例外訊息或應用程式帳戶資料
檢查設定
檢查站 1
初始化檔案註冊伺服器端中介軟體。同一邏輯 jid 在 Sidekiq 重試之間維持不變;首次嘗試為 1,retry_count 為 0 表示第 2 次嘗試。無效的重試中繼資料保留為未知。
檢查站 2
工作程式碼區塊返回並不能證明後續交付成功。StandardError 記錄為 raised,並原樣重新拋出;其他未返回的退出維持為 not_returned。
檢查站 3
此範例不測量佇列等待、重試耗盡或 Active Job 獨立的重試策略。請在各自經過驗證的生命週期掛鉤中加入這些記錄。
檢查站 4
耗時採用單調時鐘,不包含同步匯出時間。匯出仍占用工作程序,並增加處理延遲。
檢查站 5
傳輸、非 2xx 回應、編碼、中繼資料和診斷失敗均被隔離。缺少金鑰時略過匯出,不改變工作結果或原始例外。
檢查站 6
連線、讀取和寫入逾時均為一秒,並非嚴格的總時限。沒有匯出重試、持久佇列或關閉時排空機制;若不能接受遺失,請使用應用程式自行管理的寄件匣。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。
Sidekiq job telemetry 驗證查詢
SELECT *
FROM job_attempt_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。
在哪裡記錄事件
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID,所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件結構描述範例
此工作流程的事件結構描述
在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
更多 SQL 範例
針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。
測量後台作業重試和失敗率
哪些後台作業消耗的重試次數最多或仍然失敗?
開啟查詢範例按作業測量佇列等待時間
哪些工作在工人開始之前等待的時間最長?
開啟查詢範例使用 SQL 查詢停滯的後台作業
哪些作業已啟動但從未產生終止事件?
開啟查詢範例測量死信佇列成長
哪些佇列新增死信作業的速度比解決死信作業的速度快?
開啟查詢範例檢測後台作業重試風暴
目前哪些工作型別在重試上花費的工作量最多?
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合