Sidekiq Job Telemetry：從邊界到驗證行
在受控應用程式邊界使用 Sidekiq Job Telemetry，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Sidekiq 重試監控
- 2
定義合約
job_id、job_name、queue_name、狀態和嘗試
- 3
埋點邊界
將收益包裝在伺服器中介軟體中，以便每次執行嘗試都有一個結果；使用 jid 作為邏輯識別符號，並使用 retry_count 加一作為嘗試。
- 4
核實證據
Exercise a known fixture, then inspect job_attempt_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- 具有顯式開啟和讀取超時的可重用 Ruby HTTP 包裝器
- Sidekiq 伺服器中介軟體在每個工作處理程序中註冊
- 穩定的作業類和佇列名稱以及批准的錯誤分類法
交貨設定
安裝並初始化伺服器端
使用帶有伺服器端金鑰以及顯式開啟和讀取超時的小型 Net::HTTP 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Sidekiq Job Telemetry事件
class TelemetryOutcomeMiddleware
include Sidekiq::ServerMiddleware
def call(_job_instance, job, queue)
started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
status = "success"
error_type = nil
begin
yield
rescue => error
status = "failed"
error_type = classify_error(error)
raise
ensure
TelemetryHttp.log(
table: "job_attempt_completed",
data: {
job_id: job["jid"],
job_name: job["class"],
queue_name: queue,
attempt: job.fetch("retry_count", -1) + 2,
status: status,
duration_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
error_type: error_type,
release: ENV["APP_RELEASE"]
}
)
end
end
end活動合約
job_id、job_name、queue_name、狀態和嘗試
queue_wait_ms、duration_ms、error_type、retry_exhausted 和釋放
item_count 或由作業派生的批准帳戶上下文，從不序列化參數
實施檢查點
檢查站 1
將收益包裝在伺服器中介軟體中，以便每次執行嘗試都有一個結果；使用 jid 作為邏輯識別符號，並使用 retry_count 加一作為嘗試。
檢查站 2
不要在沒有重新加註的情況下救援，因為 Sidekiq 必須遵守異常才能應用其重試政策。
檢查站 3
如果每次嘗試都會發出事件，請明確建置終端成功和重試耗盡指標，以便重試不會增加作業總數。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Sidekiq Job Telemetry 驗證查詢
SELECT *
FROM job_attempt_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
測量後台作業重試和失敗率
哪些後台作業消耗的重試次數最多或仍然失敗？
開啟查詢範例按作業測量佇列等待時間
哪些工作在工人開始之前等待的時間最長？
開啟查詢範例使用 SQL 查詢停滯的後台作業
哪些作業已啟動但從未產生終止事件？
開啟查詢範例測量死信佇列成長
哪些佇列新增死信作業的速度比解決死信作業的速度快？
開啟查詢範例檢測後台作業重試風暴
目前哪些工作型別在重試上花費的工作量最多？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合