跳至主要內容
Telemetry
整合指南

Spring Boot 結構化事件監控

透過 Telemetry 的 HTTP API 記錄 Spring MVC 和預定工作流程結果,並提供穩定的路由、延遲、狀態和追蹤上下文。

審閱者 Telemetry產品團隊 . 埋點合約、隱私邊界和實施指南. 審查標準和所有權

有用於
  • Spring API 可靠性
  • 預定作業監控
  • 跡線相關性
實施證據

Spring Boot Structured Event Monitoring:從邊界到驗證行

在受控應用程式邊界使用 Spring Boot Structured Event Monitoring,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。

  1. 1

    選擇結果

    Spring API 可靠性

  2. 2

    定義合約

    route_template、方法、status_code 和 latency_ms

  3. 3

    埋點邊界

    在知道回應狀態後發出並對已處理的異常進行一致的分類。

  4. 4

    核實證據

    Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

開始之前

先決條件和界限

  • 伺服器端TELEMETRY_API_KEY
  • 具有有限重試功能的已設定 HTTP 客戶端
  • 標準化 Spring 路線模式

交貨設定

安裝並初始化伺服器端

使用一個共享 Java HTTP 客戶端,該客戶端具有伺服器端金鑰、有限超時和一個小型允許列表日誌 API 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。

  1. 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
  2. 2在成功、失敗、重試或超時邊界處新增結果事件。
  3. 3在啟用警示之前傳送受控裝置並檢查儲存的行。

片段

從一個結構化事件開始

在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。

spring-boot

Spring Boot Structured Event Monitoring事件

java
telemetry.log("api_request_completed", Map.of(
    "route_template", bestMatchingPattern(request),
    "method", request.getMethod(),
    "status_code", response.getStatus(),
    "status", response.getStatus() >= 500 ? "failed" : "success",
    "latency_ms", elapsedMillis,
    "trace_id", currentTraceId(),
    "release", applicationRelease
));

活動合約

route_template、方法、status_code 和 latency_ms

狀態、error_type、trace_id 和發布

服務、環境和安全帳戶識別符號

實施檢查點

檢查站 1

在知道回應狀態後發出並對已處理的異常進行一致的分類。

檢查站 2

不要將請求正文、安全上下文或異常訊息序列化為事件。

檢查站 3

使用相同的事件契約來進行控制器建議和正常攔截器完成。

驗證

證明事件已到達

在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。

spring-boot-verification

Spring Boot Structured Event Monitoring 驗證查詢

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
確認每個邏輯結果的一個終端行,以及預期狀態、識別符號、單位和 UTC 時間。
檢查推斷的架構並驗證重試不會更改欄位型別或生成新的邏輯事件 ID。
在儲存的欄位中搜尋憑據、原始有效負載、提示、私有內容和無限制的錯誤訊息。
在將儀表板視為完整之前,請執行提供程式超時、攝取拒絕和處理程序關閉。

實施參考

在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。

生產邊界

保持結果事件小且可恢復

該模式提供了

  • 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
  • 用於儀表板、警示和跨事件關聯的穩定欄位。
  • 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。

該模式不提供

  • OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
  • 僅因為有效負載包含事件 ID,所以僅傳送一次。
  • 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。

事件架構起點

在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。

相關產品功能

繼續此工作流程 警示

將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。

相關 SQL 查詢範例

用 SQL 回答下一個問題

針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。

瀏覽所有查詢範例
完整系列API 可靠性 SQL

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合