Elixir Phoenix Telemetry Integration:從邊界到驗證行
在受控應用程式邊界使用 Elixir Phoenix Telemetry Integration,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Phoenix API 可靠性
- 2
定義合約
route_template、方法、status_code、狀態、duration_ms 和發布
- 3
埋點邊界
在應用程式啟動期間附加一次並處理終端 Phoenix 端點或路由器排程停止事件;使用 System.convert_time_unit/3 轉換本機持續時間單位。
- 4
核實證據
Exercise a known fixture, then inspect your_event_table for one correctly typed terminal row.
開始之前
先決條件和界限
- 啟用 Phoenix 端點遙測並安裝一次處理程式的受監督應用程式處理程序
- 具有有限連線和回應超時的伺服器端 HTTP 客戶端
- 路由範本、狀態和受控錯誤分類,不包括請求參數和連線內容
交貨設定
安裝並初始化伺服器端
使用具有伺服器端金鑰、有限 HTTP 超時和顯式重試限制的受監督客戶端處理程序。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Elixir Phoenix Telemetry Integration事件
defmodule MyAppWeb.TelemetryOutcome do
def attach do
:telemetry.attach(
"telemetry-phoenix-request-outcome",
[:phoenix, :endpoint, :stop],
&__MODULE__.handle_stop/4,
nil
)
end
def handle_stop(_event, measurements, metadata, _config) do
conn = metadata.conn
event = %{
route_template: conn.private[:phoenix_route] || "unmatched",
method: conn.method,
status_code: conn.status,
status: if(conn.status < 500, do: "success", else: "failed"),
duration_ms:
System.convert_time_unit(measurements.duration, :native, :millisecond),
release: System.get_env("APP_RELEASE", "development")
}
# Supervise this app-owned client and give it bounded HTTP timeouts.
MyApp.TelemetryIngest.enqueue("phoenix_request_completed", event)
end
end活動合約
route_template、方法、status_code、狀態、duration_ms 和發布
request_id、account_id、環境、node_role 和受控 error_type(經批准後)
沒有 conn.params、查詢字串、請求或回應正文、會話、授權標頭、堆疊追蹤或不受限制的後設資料
實施檢查點
檢查站 1
在應用程式啟動期間附加一次並處理終端 Phoenix 端點或路由器排程停止事件;使用 System.convert_time_unit/3 轉換本機持續時間單位。
檢查站 2
Phoenix 和 Plug 停止事件不構成完整的分散式跨度,Plug 記錄了錯誤後未發出停止事件的情況。保留該診斷邊界的異常和追蹤工具。
檢查站 3
透過受監督、有界的傳送路徑非同步轉發,因此遙測 HTTP 延遲不會延長使用者請求或破壞應用程式信箱的穩定性。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。
Elixir Phoenix Telemetry Integration 驗證查詢
SELECT *
FROM your_event_table
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID,所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。
按路由計算 API 請求吞吐量
哪些 API 路由每分鐘處理的請求最多?
開啟查詢範例按路由計算API錯誤率
哪些 API 路由具有最高的有意義 5xx 錯誤率?
開啟查詢範例計算 p50、p95 和 p99 API 延遲
哪些端點的尾部延遲最差?
開啟查詢範例按路由計算API超時率
哪些 API 路由超時的頻率足以影響使用者?
開啟查詢範例比較依賴性 p95 延遲
哪些下游依賴項的尾部延遲和故障率最差?
開啟查詢範例按客戶影響對錯誤指紋進行排名
哪些錯誤組影響最多的客戶帳戶?
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合