跳转到内容
Telemetry
集成指南

.NET 和 Serilog 结构化事件分析

除了针对 ASP.NET 请求延迟、故障、版本和客户影响的 Serilog 诊断之外,添加重点 Telemetry 结果事件。

审阅者 Telemetry产品团队 . 埋点合约、隐私边界和实施指南. 审查标准和所有权

有用于
  • ASP.NET API 监控
  • 序列相关性
  • 依赖可靠性
实施证据

.NET and Serilog Structured Event Analytics:从边界到验证行

在受控应用程序边界使用 .NET and Serilog Structured Event Analytics,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    ASP.NET API 监控

  2. 2

    定义合同

    route_template、方法、status_code 和状态

  3. 3

    埋点边界

    在将受控的 error_type 发送到 Telemetry 时,在 Serilog 中保留详细的异常。

  4. 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. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

dotnet-serilog

.NET and Serilog Structured Event Analytics事件

csharp
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

传播活动跟踪标识符以进行关联,而无需重复跨度。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

dotnet-serilog-验证

.NET and Serilog Structured Event Analytics 验证查询

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

生产边界

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件架构起点

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 告警

将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。

相关 SQL 查询示例

用 SQL 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例
完整系列API 可靠性 SQL

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成