跳转到内容
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-验证

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

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成