API-Überwachung: Prüfungen, Assertions und Nutzerabläufe

Überwache eine API auf mehr als Erreichbarkeit: überprüfe die erwartete Antwort, erkenne Verlangsamungen und benachrichtige die richtigen Personen, wenn der Vertrag verletzt wird.

Den richtigen Monitor wählen

Verwende HTTP für einen einfachen Endpunkt und eine Statuscode-Prüfung. Verwende API, wenn die Anfrage Methode, Body, Header, Authentifizierung oder eine Antwort-Assertion benötigt. Verwende Browser, wenn Erfolg von mehreren nutzerseitigen Schritten wie Anmeldung, Navigation oder Checkout abhängt. Verwende Heartbeat, wenn der aufrufende Dienst der beste Nachweis für abgeschlossene Hintergrundarbeit ist.

Eine aussagekräftige Assertion konfigurieren

Beginne mit einem stabilen Health- oder Readiness-Endpunkt. Erwarte einen bestimmten Statuscode und, wenn nützlich, einen kleinen Wert im Antworttext, der die Bereitschaft der Abhängigkeit belegt. Speichere Anmeldedaten als Secrets in der Monitorkonfiguration; niemals in öffentlicher Dokumentation, Statusseiten oder Client-Code.

Beispiel für eine HTTP/API-Assertion

GET https://api.example.com/health
Expected status: 200
Expected body: {"ok":true}

Assertions für den Antworttext

Ein Statuscode sagt nur, dass der Server geantwortet hat. Die Schlüsselwortprüfung prüft, was zurückkam. Gib eine Assertion pro Zeile ein: Alle Zeilen müssen passen, mehrere Zeilen wirken also als UND, nicht als ODER. Mit regulären Ausdrücken wird jede Zeile als RE2-Muster behandelt und kann veränderliche Werte prüfen. Die Option für fehlende Schlüsselwörter kehrt die Prüfung um und schlägt fehl, wenn Text oder Muster gefunden werden. RE2 unterstützt kein Lookahead, Lookbehind oder Backreferences; durchsucht wird nur das erste MB der Antwort.

Schlüsselwort-Assertions, wörtlich und regulär

# Literal: every line must appear in the body
"status":"ok"

# Regular expression (RE2): every line must match
"status"\s*:\s*"(ok|healthy)"
"version":"4\.[0-9]+"

Wenn ein Endpunkt nicht genügt

Eine API kann 200 zurückgeben, während der kundenorientierte Ablauf dennoch fehlschlägt. Browser-Überwachung kann die Reise einer Person durch die Anwendung validieren. Für Queues, Cron-Jobs, Backups und Deploy-Pipelines ist ein geplanter Heartbeat oft das zuverlässigere Signal, weil er den Abschluss statt nur Verfügbarkeit bestätigt.

Bewusst auf Ausfälle reagieren

Sende Incidents an die Benachrichtigungskanäle, die dein Team tatsächlich beobachtet, und füge Trigger für sicher automatisierbare Aktionen hinzu. Trenne rauschende Prüfungen von kundenwirksamen Prüfungen, damit jeder Ausfall einen klaren Verantwortlichen und Benachrichtigungsweg hat.