Webhook のモニター
Webhook が構成されると、多くの場合、Webhook がユーザー・フローの中核部分を構成します。 Webhook の失敗はユーザーにとっては意味がないため、Webhook の失敗は記録されますが、発生時にユーザーに返されることはありません。 webhooks stats Webhookの失敗を確認するには、APIを取得する必要があります。
Webhook 統計 API を使用すると、Webhook 使用状況の詳細な明細を取得できます。 これらの統計の有用性は広範囲におよびます。
統計のモニターは、以下のタスクに役立ちます。
- 特定の URL の障害の検出および修正。
- Verify と構成済み Webhook エンドポイントの間の待ち時間のモニター
障害が検出されると、障害の Webhook 要求 ID が、Webhook エンジンが生成したエラーとともに記録されます。 このエラー・メッセージを要求 ID とともに使用して、外部システム上の要求ログと相関させ、障害をトリアージして解決することができます。
注： 統計データは定期的に更新され、最大で5秒ごとに変更される場合があります。
一目でわかる正常性
また、統計情報の詳細を活用して、Webhookの正常性を簡潔に把握できるAPIも health 用意されています。
この API は、以下のいずれかの値を返します。
no-data- この Webhook の使用可能な統計情報はありません。 使用されたことがないか、過去 7 日間に使用されていないかのいずれかです。
down- 以前には正常に接続されたこの Webhook のすべての構成済み URL にエラーが発生しました。
recovered- 接続に失敗した 1 つ以上の URL が正常に接続されました。
marginal- 1 つの URL は一貫して機能していますが、他の URL は失敗しています。
good- エラーはありません。