使用 .NET and Serilog structured event analytics 傳送並驗證事件
在受控應用程式邊界使用 .NET and Serilog structured event analytics，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
ASP.NET API 監控
- 2
定義合約
route_template、方法、status_code 和狀態
- 3
在結果處發出
在將受控的 error_type 傳送到 Telemetry 時，在 Serilog 中保留詳細的異常。
- 4
核實證據
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
開始之前
開始之前
- 伺服器端TELEMETRY_API_KEY
- 命名的 ASP.NET 端點
- 具有較短超時時間的 HttpClient
交貨設定
安裝並初始化伺服器端
使用一個共享的 HttpClient 和伺服器端金鑰、較短的超時時間和一個小的允許列表日誌 API 包裝器。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
.NET and Serilog structured event analytics事件
await telemetryClient.LogAsync("api_request_completed", new {
route_template = context.GetEndpoint()?.DisplayName ?? "unmatched",
method = context.Request.Method,
status_code = context.Response.StatusCode,
status = context.Response.StatusCode >= 500 ? "failed" : "success",
latency_ms = stopwatch.Elapsed.TotalMilliseconds,
trace_id = Activity.Current?.TraceId.ToString(),
release = configuration["APP_RELEASE"]
});事件結構
route_template、方法、status_code 和狀態
latency_ms、trace_id、error_type 和依賴性
環境、發布和安全租戶識別符號
檢查設定
檢查站 1
在將受控的 error_type 傳送到 Telemetry 時，在 Serilog 中保留詳細的異常。
檢查站 2
讀取匹配的端點路由模式而不是Request.Path。
檢查站 3
傳播活動追蹤識別符號以進行關聯，而無需重複跨度。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
.NET and Serilog structured event analytics 驗證查詢
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
在哪裡記錄事件
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件結構描述範例
此工作流程的事件結構描述
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
更多 SQL 範例
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按路由計算API錯誤率
在至少有 20 次請求的 API 路由中，哪些路由的 5xx 錯誤率最高？
開啟查詢範例比較依賴性 p95 延遲
哪些下游依賴項的尾部延遲和故障率最差？
開啟查詢範例根據 SLO 衡量 API 可用性
每項服務是否達到其每日可用性目標？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合