使用 .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 可用性
每项服务是否达到其每日可用性目标？
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成