监视 Webhook

配置 Webhook 时,它们通常会构成用户流的核心部分。 Webhook 故障对用户没有意义,因此 Webhook 故障会被记录,但在发生时不会通知用户。 要查看 Webhook 失败情况,必须检索相关 webhooks stats API。

通过 Webhook 统计信息 API,可以获取 Webhook 使用情况的详细细目。 这些统计信息的可用性非常广泛。

监视统计信息可帮助执行以下任务。
  • 检测特定 URL 上的故障并进行补救。
  • 监视 Verify 与已配置 Webhook 端点之间的等待时间
检测到故障时,系统会记录该故障的 Webhook 请求标识以及该 Webhook 引擎生成的错误。 此错误消息及请求标识应该用于关联外部系统上的请求日志,以进行分类并解决故障。
注意: 统计数据会定期刷新,更新频率最高可达每五秒一次。

运行状况一览

此外,还提供了一个 health API,它利用统计数据的详细信息,以简化的形式展示 webhook 的运行状况。

此 API 返回下列其中一个值。
no-data
此 Webhook 没有可用的统计信息。 或者从来没有使用过,或者过去 7 天没有使用过。
down
先前成功连接的此 Webhook 的所有已配置 URL 现在存在错误。
recovered
至少一个 URL 发生连接故障并且现在已成功连接。
marginal
一个 URL 以一致方式工作,其他 URL 失败。
good
不存在任何错误。