Webhooks überwachen
Wenn Webhooks konfiguriert werden, bilden diese häufig einen zentralen Teil der Benutzerabläufe. Webhook-Fehler sind für einen Benutzer nicht aussagekräftig, sodass Webhook-Fehler aufgezeichnet, aber nicht an den Benutzer zurückgegeben werden, wenn sie auftreten. Um Webhook-Fehler anzuzeigen, müssen die webhooks stats APIs abgerufen werden.
Die APIs für Webhook-Statistiken ermöglichen es, eine detaillierte Aufgliederung der Webhook-Nutzung abzurufen. Die Nutzbarkeit dieser Statistiken ist weit gefasst.
Die Überwachung der Statistikdaten kann Sie bei den folgenden Tasks unterstützen:
- Fehler bei bestimmten URLs erkennen und beheben.
- Latenzzeit zwischen Verify und den konfigurierten Webhook-Endpunkten überwachen
Wenn Fehler erkannt werden, wird die Webhook-Anforderungs-ID des Fehlers zusammen mit dem Fehler aufgezeichnet, den die Webhook-Engine generiert hat. Diese Fehlernachricht sollte zusammen mit der Anforderungs-ID verwendet werden, um eine Korrelation mit den Anforderungsprotokollen auf dem externen System herzustellen, um den Fehler zu erkennen und zu beheben.
Hinweis: Die Statistiken werden regelmäßig aktualisiert und können sich bereits alle fünf Sekunden ändern.
Gesundheit auf einen Blick
Es gibt auch eine health API, die anhand der statistischen Daten einen vereinfachten Überblick über den Zustand der Webhooks bietet.
Diese API gibt einen der folgenden Werte zurück:
no-data- Für diesen Webhook sind keine statistischen Informationen verfügbar. Entweder wurde er nie benutzt oder in den letzten 7 Tagen nicht benutzt.
down- Alle konfigurierten URLs dieses Webhooks, die zuvor erfolgreich verbunden wurden, weisen jetzt einen Fehler auf.
recovered- Mindestens eine URL, bei der ein Verbindungsfehler aufgetreten ist, stellt jetzt erfolgreich eine Verbindung her.
marginal- Eine URL funktioniert konsistent, andere URLs schlagen fehl.
good- Es sind keine Fehler vorhanden.