Go HTTP Server Structured Logging：從邊界到驗證行
在受控應用程式邊界使用 Go HTTP Server Structured Logging，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Go API 可靠性
- 2
定義合約
route_template、方法和status_code
- 3
埋點邊界
使用路由器模式而不是 r.URL.Path 以避免每個資源識別符號一組。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- 使用伺服器端金鑰初始化的 telemetry-go SDK
- 記錄最終狀態程式碼的回應編寫器包裝器
- 來自應用程式路由器的標準化路由名稱
交貨設定
安裝並初始化伺服器端
每個處理程序初始化一次 telemetry.NewTelemetry，或者在需要上下文取消和顯式超時時使用應用程式擁有的 http.Client。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
Go module安裝
go get github.com/telemetry-sh/telemetry-go- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Go HTTP Server Structured Logging事件
startedAt := time.Now()
next.ServeHTTP(recorder, r)
status := "success"
if recorder.StatusCode >= 500 {
status = "failed"
}
_, err := telemetryClient.Log("api_request_completed", map[string]interface{}{
"route_template": routePattern,
"method": r.Method,
"status_code": recorder.StatusCode,
"status": status,
"latency_ms": float64(time.Since(startedAt).Microseconds()) / 1000,
"request_id": requestID,
})活動合約
route_template、方法和status_code
狀態、latency_ms 和 request_id
服務、環境、發布
實施檢查點
檢查站 1
使用路由器模式而不是 r.URL.Path 以避免每個資源識別符號一組。
檢查站 2
在同一個記錄的結果模型中捕獲恐慌和提前退出。
檢查站 3
不要使攝取錯誤覆蓋應用程式回應；透過服務的診斷路徑報告它們。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Go HTTP Server Structured Logging 驗證查詢
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按路由計算API錯誤率
哪些 API 路由具有最高的有意義 5xx 錯誤率？
開啟查詢範例計算 p50、p95 和 p99 API 延遲
哪些端點的尾部延遲最差？
開啟查詢範例按版本比較 API 可靠性
哪些版本會出現更嚴重的 API 錯誤或尾部延遲？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合