Ruby on Rails Structured Event Analytics：从边界到验证行
在受控应用程序边界使用 Ruby on Rails Structured Event Analytics，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
Rails 请求监控
- 2
定义合同
controller_action、方法和status_code
- 3
埋点边界
发送列入白名单的有效负载，而不是序列化请求参数。
- 4
核实证据
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- 服务器端TELEMETRY_API_KEY
- 具有显式打开和读取超时的小型 HTTP 客户端
- 标准化控制器操作或路由名称
交货设置
安装并初始化服务器端
使用带有服务器端密钥以及显式打开和读取超时的小型 Net::HTTP 包装器。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Ruby on Rails Structured Event Analytics事件
payload = {
table: "api_request_completed",
data: {
controller_action: "#{controller_name}##{action_name}",
method: request.method,
status_code: response.status,
status: response.server_error? ? "failed" : "success",
latency_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
request_id: request.request_id
}
}
TelemetryHttp.log(payload)活动合约
controller_action、方法和status_code
状态、latency_ms 和 error_type
request_id、account_id，并释放
实施检查点
检查站 1
发送列入白名单的有效负载，而不是序列化请求参数。
检查站 2
处理摄取失败，无需打印 API 密钥或更改已完成的客户响应。
检查站 3
在控制器和 Active Job 工作线程中使用相同的字段类型。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
Ruby on Rails Structured Event Analytics 验证查询
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 仪表板
将经过验证的产品或收入查询转变为集中的决策界面。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
与此集成配对的模板
更多集成