跳转到内容
Telemetry
浏览文档
概念与 SQL 模式更新于 2026年7月27日由 Telemetry 编辑团队和产品团队审核阅读约需 2 分钟

让编程智能体使用这篇文档

打开 Claude Code、Codex、Cursor 或其他编码代理的集中提示包,然后将其适应此处介绍的工作流程。

本页内容
  1. 命名结果
  2. 从问题中选择字段
  3. 改变计划
  4. 审查清单

设计事件架构

事件架构是发出数据的代码与使用数据的每个查询、仪表板、告警或导出之间的契约。仪器仪表前的少量设计可以防止数月的模糊数据。

命名结果

使用稳定的名词和过去时结果,例如 api_request_completedjob_failedsubscription_renewed。避免频繁更改的 UI 措辞。当成功和失败共享相同的有用字段时,具有受控 status 值的一个事件通常比单独的表更容易比较。

从问题中选择字段

对于每个计划的问题,确定操作:

  • 过滤器需要环境、功能、路线或状态等字段。
  • 组需要受控维度,例如模型、版本或错误类型。
  • 计算需要具有明确单位的键入测量值。
  • 调查需要连接相关事件的安全标识符。

记录 latency_ms,而不是 latency。将数值存储为数字,将布尔值存储为布尔值。使用 UTC 时间戳。优先选择 route_template 而不是原始 URL,优先选择 error_type 而不是无界异常消息。

记录标识符是否代表个人、帐户、请求或工作。如果字段可能包含敏感数据,请在创建事件之前忽略或转换它。

改变计划

附加更改通常是最安全的:查询可以容忍新的可为空字段。重命名字段或更改其类型可能会破坏每个消费者。当语义发生重大变化时,添加 event_version,编写处理迁移窗口的查询,并仅在消费者移动后删除旧形状。

保留具有代表性的成功、失败、重试和超时示例以进行验证。在发布仪器更改之前运行重要的 SQL。仅当真实分支生成的值与其记录的含义相匹配时,模式才是完整的。

审查清单

询问事件是否有明确的所有者、一组有界的状态值、明确的单位、安全标识符和保留需求。确认至少有一个实际查询使用每个字段。仅仅因为它们可用而删除包含的值。

有关完整的事件合约示例,请参阅 图式演化脱敏敏感数据SQL食谱

将本指南付诸实践

连接您的第一个真实事件

将设置提示粘贴到编码代理中,运行一个真实的应用程序流程,然后验证事件并构建您的第一个查询。样本数据仍然是可选的。

无需信用卡。自动创建明确标记的示例事件和准备运行的查询,因此不需要生产数据来评估工作流程。

  1. 1. 创建一个标记明确的示例事件
  2. 2. 打开准备运行的查询
  3. 3. 将结果保存到您的仪表板

相关产品功能

记录稳定的事件名称、类型明确的字段,以及经过隐私审核的上下文。

内容责任与技术参考

Telemetry 编辑团队负责维护本文;产品团队审核功能行为、示例和适用范围。

查看编辑规范