跳转到内容
Telemetry
集成指南

Stripe Webhook 与 Telemetry 集成

调试支付、订阅、发票、重试和下游计费同步行为,无需存储 Webhook 主体。

审阅者 Telemetry产品团队 . 我们检查了要发送的事件、要排除的数据和代码添加方法. 谁负责审核此页面

有用于
  • Webhook 调试
  • 计费可靠性
  • 收入运营
实施证据

使用 Stripe webhook telemetry 发送并验证事件

在受控应用程序边界使用 Stripe webhook telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    Webhook 调试

  2. 2

    定义合同

    provider_event_id、event_type、实时模式、端点和 received_at

  3. 3

    在结果处发出

    在信任或记录任何事件字段之前验证 Stripe-Signature 标头,并且切勿将签名或原始正文发送到 Telemetry。

  4. 4

    核实证据

    Exercise a known fixture, then inspect webhook_processed for one correctly typed terminal row.

开始之前

开始之前

  • 一个服务器端点,用于根据未修改的请求正文验证 Stripe 签名
  • 由 Stripe 事件标识符键入的持久重复数据删除
  • 下游工作缓慢的快速确认路径已转移到幂等工作

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

stripe-webhooks-安装

npm安装

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

片段

从一个结构化事件开始

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

stripe-webhooks

Stripe webhook telemetry事件

javascript
await telemetry.log("webhook_processed", {
  provider: "stripe",
  provider_event_id: event.id,
  event_type: "invoice.payment_succeeded",
  status: "success",
  latency_ms: 328,
  downstream_job_count: 2,
  idempotency_outcome: "new_event",
  livemode: event.livemode,
});

事件结构

provider_event_id、event_type、实时模式、端点和 received_at

状态、status_code、latency_ms、尝试和 idempotency_outcome

downstream_job、downstream_status、error_type、account_id 和释放

检查配置

检查站 1

在信任或记录任何事件字段之前验证 Stripe-Signature 标头,并且切勿将签名或原始正文发送到 Telemetry。

检查站 2

重复发货与重复业务处理分开记录;事件标识符应该使后者不可能。

检查站 3

将已确认的交付连接到下游作业结果,以便快速的 2xx 响应无法隐藏失败的订阅或发票工作。

验证

证明事件已到达

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

stripe-webhooks-验证

Stripe webhook telemetry 验证查询

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

实施参考

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

在哪里记录事件

保持结果事件小且可恢复

该模式提供了

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

该模式不提供

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

事件模式示例

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

相关产品功能

继续此工作流程 仪表板

将经过验证的产品或收入查询转变为集中的决策界面。

相关 SQL 查询示例

更多 SQL 示例

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成