So überwachen Sie, ob ein API-Gateway-Endpunkt tatsächlich erreichbar ist

Problemsymptome

Möglicherweise sehen Sie eines oder mehrere der folgenden Symptome:

• Für einen API-Gateway-Endpunkt ist kein Signal für die direkte Erreichbarkeit verfügbar.

• API-Gateway-Metriken zeigen keine dedizierte Zustandsmetrik an.

• Trafficvolumen, Latenz und Response-Code-Trends bestätigen die Endpunkt-Liveness nicht.

• Für den API Gateway-Deployment-Endpunkt ist kein OCI-nativer Health Check konfiguriert.

Mögliche Gründe

Endpunkterreichbarkeit und Gateway-Metriken messen verschiedene Teile des Anforderungspfads:

• Health Checks geben an, ob ein bereitgestellter API-Pfad über den Health-Check-Probe-Speicherort erreichbar ist.

• API-Gateway-Metriken geben an, wie sich das Gateway verhält, nachdem der Traffic das Gateway erreicht hat.

• Ein erreichbares Gateway kann immer noch zunehmende 4xx- oder 5xx-Antworten zurückgeben.

• Ein Gateway mit wenig oder keinem Datenverkehr kann nur wenige aktuelle Metrikdatenpunkte aufweisen, was Metriken allein zu einem schwachen Liveness-Signal macht.

Health Check für Endpunktlebensdauer konfigurieren

Verwenden Sie Health Checks, wenn Sie ein binäres oder nahezu binäres Signal benötigen, dass ein bereitgestellter Endpunkt erreichbar ist.

Wählen Sie eine API-Route aus, die den folgenden Anforderungen entspricht:

• Die Route gibt eine vorhersehbare Erfolgsantwort zurück, wie 200 oder 204.

• Die Route löst keine Anmeldeumleitungen aus.

• Für die Route sind keine Benutzerzugangsdaten oder kurzlebige Abfrageparameter erforderlich.

• Die Route führt keinen Schreibvorgang aus und erzeugt keinen geschäftlichen Effekt.

• Die Route stellt den API-Gatewaypfad dar, den Sie überwachen möchten.

Bevor Sie den Health Check erstellen, prüfen Sie die Route manuell:

curl -i https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

Erstellen Sie einen OCI-Health Check, der auf den genau bereitgestellten Endpunkt abzielt, den Sie geprüft haben. Verwenden Sie den Health Check für die folgenden Überwachungsziele:

• Erreichbarkeit des Endpunkts

• Externe Verfügbarkeitsprüfungen

• Warnt, wenn der Endpunkt nicht mehr mit dem erwarteten Statuscode reagiert.

API-Gateway-Metriken prüfen

Verwenden Sie API-Gateway-Metriken, um Traffic- und Ausfallmuster zu verstehen, nachdem der Endpunkt erreichbar ist. Prüfen Sie im Metrik-Explorer die öffentlichen API-Gatewaymetriken im Namespace oci_apigateway.

Beginnen Sie mit den folgenden Metriken und Dimensionen:

• HttpResponses, httpStatusCode und httpStatusCategory.

• BackendHttpResponses, backendHttpStatusCode und backendHttpStatusCategory.

• Latency, IntegrationLatency und InternalLatency.

• resourceId, deploymentId und route.

Verwenden Sie HttpResponses, um die vom API-Gateway zurückgegebenen Statuscodes zu prüfen. Verwenden Sie BackendHttpResponses, um Statuscodes zu prüfen, die von Backend-Services zurückgegeben werden.

Überwachungsergebnisse interpretieren

Verwenden Sie Health Check-Status und API-Gateway-Metriken zusammen, um zu ermitteln, wo das Problem auftritt:

• Wenn der Health Check nicht erfolgreich verläuft, kann der Endpunkt vom Probe-Pfad nicht erreichbar oder fehlerhaft sein.

• Wenn der Health Check erfolgreich verläuft, die 4xx- oder 5xx-Antworten jedoch zunehmen, ist der Endpunkt erreichbar, Anforderungen sind jedoch nicht erfolgreich.

• Wenn der Datenverkehr gering ist und Metriken keine aktuellen Daten anzeigen, belegen die fehlenden Daten nicht, dass das Gateway nicht verfügbar ist.

• Wenn die Erreichbarkeit erfolgreich ist, die Latenz jedoch steigt, ist das Gateway erreichbar, die Anforderungsverarbeitung kann jedoch beeinträchtigt werden.

Monitoringlücken beheben

Verwenden Sie das Überwachungssignal, das der Frage entspricht, die Sie beantworten müssen:

• Um die Endpunktgültigkeit zu überwachen, konfigurieren Sie Health Checks für eine bereitgestellte API-Route.

• Prüfen Sie die API-Gateway-Metriken, um das Antwortverhalten zu untersuchen.

• Um Verfügbarkeit und Verhalten zu überwachen, kombinieren Sie Health Checks mit API-Gateway-Metriken und -Alarmen.

• Um falsche Schlussfolgerungen zu vermeiden, verlassen Sie sich nicht auf eine API-Gateway-Metrik als direkten Gateway-Alive-Indikator.

Endpunktüberwachung prüfen

Nachdem Sie das Endpunktmonitoring konfiguriert haben, prüfen Sie das Setup:

• Bestätigen Sie, dass der ausgewählte API-Pfad den erwarteten Statuscode zurückgibt, wenn Sie ihn mit curl testen.

• Stellen Sie sicher, dass der OCI Health Check den Endpunkt erfolgreich prüfen kann.

• Bestätigen Sie, dass im Metrik-Explorer Anforderungs- und Antworttrends für das Gateway angezeigt werden.

• Stellen Sie sicher, dass Alarme Endpunkterreichbarkeitsprobleme von Antwortcode- oder Latenzproblemen unterscheiden.

Weitere Informationen

Weitere Informationen finden Sie unter:

• Health Checks

• HTTP-Monitor erstellen

• API-Gateway-Metriken