使用 Supabase and Postgres app telemetry 发送并验证事件
在受控应用程序边界使用 Supabase and Postgres app telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。
- 1
选择结果
API 可靠性
- 2
定义合同
function_name、route_template、方法、status_code 和区域
- 3
在结果处发出
将 Telemetry 密钥和 Supabase 秘密或服务角色凭证保存在服务器端功能秘密中;切勿将它们暴露给浏览器代码。
- 4
核实证据
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
开始之前
开始之前
- Supabase Edge Function 或其他具有 Telemetry 密钥的可信服务器运行时
- 在特权数据库工作之前强制执行行级安全性和应用程序授权
- 用于直接数据库访问的池化或无服务器友好的 Postgres 连接路径
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Supabase and Postgres app telemetry事件
await telemetry.log("api_request_completed", {
function_name: "sync-project",
route_template: "/api/projects/:id/sync",
method: "POST",
status_code: 200,
status: "success",
latency_ms: 266,
database_operation: "sync_project",
team_id: team.id,
region: Deno.env.get("SB_REGION"),
});事件结构
function_name、route_template、方法、status_code 和区域
状态、latency_ms、database_operation、rows_affected 和 error_type
request_id、account_id、版本和环境
检查配置
检查站 1
将 Telemetry 密钥和 Supabase 秘密或服务角色凭证保存在服务器端功能秘密中;切勿将它们暴露给浏览器代码。
检查站 2
记录应用程序结果,而不是 SQL 文本、连接字符串、请求正文或不受限制的数据库错误。
检查站 3
当诊断需要区分功能延迟和数据库操作延迟时。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。
Supabase and Postgres app telemetry 验证查询
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。
在哪里记录事件
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID,所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件模式示例
此工作流的事件模式
在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 仪表板
将经过验证的产品或收入查询转变为集中的决策界面。
相关 SQL 查询示例
更多 SQL 示例
针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。
按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成