Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Gehen Sie ein Beispielszenario durch, das zeigt, wie Sie 5xx-Probleme mit Ihren APIs beheben können.
| # | Step | Beschreibung |
|---|---|---|
| 1 | Überwachen Sie den letzten API-Traffic. | Zeigen Sie die letzten API-Überwachungsdaten für alle API-Proxys und Ziele an, die in der letzten Stunde Traffic hatten. Schlüsseln Sie API-Proxys oder Ziele mit einer hohen Fehlerprozentsatzrate auf. |
| 2 | Trends in Ihren API-Überwachungsdaten erkennen | Greifen Sie auf eine Verlaufsansicht Ihrer API-Überwachungsdaten der letzten drei Monate zu, um einen umfassenderen Überblick zu erhalten. |
| 3 | 5xx-Probleme untersuchen | Zeigen Sie die Fehlercodes an, die im Laufe der Zeit die höchsten relativen Volumina aufweisen, um die Quelle der 5xx-Probleme weiter zu untersuchen. (In der Regel können 5xx-Statuscodes mit einem oder mehreren Fehlercodes klassifiziert werden.) |
| 4 | 5xx-Alarm einrichten | Richten Sie eine Benachrichtigung ein, damit Sie informiert werden, wenn die Anzahl der 5xx-Statuscodes einen bestimmten Grenzwert überschreitet. |
| 5 | Generieren Sie einen benutzerdefinierten Bericht mit Kundendetails (optional) | Generieren Sie optional einen benutzerdefinierten Bericht, um Details über den Client zu ermitteln, der die 5xx-Fehler auslöst. Hinweis: Sie müssen Organisationsadministrator sein , um einen benutzerdefinierten Bericht erstellen zu können. |
| 6 | API-Proxys in einer Sammlung gruppieren | Erstellen Sie eine Sammlung, um API-Proxys zu gruppieren, und richten Sie geeignete Warnschwellenwerte für alle Mitglieder der Gruppe ein, um Probleme schneller zu diagnostizieren.
|
| 7 | Beheben Sie die 5xx-Probleme | Ergreifen Sie auf der Grundlage Ihrer Untersuchung und Diagnose geeignete Maßnahmen, um die 5xx-Probleme zu beheben. |
Schritt 1: Überwachen des letzten API-Traffics
So zeigen Sie API-Überwachungsdaten für die API-Proxys und Ziele an, die in der letzten Stunde Traffic hatten:
- Wählen Sie Analysieren > API-Überwachung > Zuletzt in der Edge-Benutzeroberfläche aus, um auf das Dashboard Zuletzt zuzugreifen.
Beachten Sie die API-Proxys und Ziele, die in der letzten Stunde eine hohe Fehlerprozentsatzrate hatten.
Klicken Sie auf den API-Proxy oder das Ziel mit einer hohen Fehlerprozentsatzrate, um Details im rechten Bereich anzuzeigen. Beachten Sie den hohen Prozentsatz der 5xx-Fehler in diesem Beispiel.
Weitere Informationen zu diesem Schritt finden Sie unter Überwachen des letzten API-Traffics.
Schritt 2: Trends in Ihren API-Überwachungsdaten erkennen
So greifen Sie auf eine Verlaufsansicht der API-Überwachungsdaten für die API-Proxys und Ziele zu, die bis zu den letzten drei Monaten Traffic hatten:
- Wählen Sie im rechten Bereich des Dashboards „Zuletzt“ die Option
> Auf der Zeitachse ansehen aus, um das Zeitachsen-Dashboard aufzurufen.
Alternativ können Sie in der Edge-Benutzeroberfläche auf Analysieren > API-Monitoring > Zeitachse klicken.
- Zeigen Sie den Trend für den API-Proxy oder das Ziel im Zeitverlauf an. Der Trend war in den letzten 7 Tagen konstant.
Weitere Informationen zu diesem Schritt finden Sie unter Identifizieren von Trends in Ihren API-Überwachungsdaten.
Schritt 3: 5xx-Probleme untersuchen
Apigee bietet eine Reihe von Fehlercodes, die Ihnen helfen sollen, Probleme zu diagnostizieren. In der Regel können 5xx-Statuscodes mit einem oder mehreren Fehlercodes klassifiziert werden.
So untersuchen Sie 5xx-Probleme:
- Wählen Sie im rechten Bereich des Zeitachsen-Dashboards die Option > In Investigate anzeigen aus, um auf das Investigate-Dashboard zuzugreifen.
Alternativ können Sie in der Edge-Benutzeroberfläche auf Analysieren > API-Überwachung > Untersuchen klicken.
Mit dem Investigate-Dashboard können Sie die relationale Aktivität zwischen Metriken vergleichen, z. B. Fehlercode im Vergleich zur Zeit. Zeigen Sie die Fehlercode-Zeit-Matrix an, um die Fehlercode-Aktivität in der letzten Stunde anzuzeigen. Beachten Sie die Fehlercodes, die basierend auf der Farbschattierung eines Blocks die höchsten relativen Volumina aufweisen. Je dunkler der Block ist, desto höher ist das relative Volumen.
Die Fehlercodes
policies.ratelimit.SpikeArrestViolationundpolicies.ratelimit.QuotaViolationzeigen beispielsweise in der folgenden Matrix ein höheres relatives Volumen:
Klicken Sie auf den dunkelsten Block (ersten Block) in der Zeile
policies.ratelimit.SpikeArrestViolation, um weitere Details im rechten Bereich zu sehen.
Beachten Sie, dass die Fehlerquelle der API-Proxy perfBenchmark_invalid_v1 und der HTTP-Statuscode 500 ist. Ein 500-Statuscode ist ein häufiger Laufzeitfehlercode für Verstöße gegen die Spike Arrest-Richtlinie.
In der App „Distribution nach Entwickler“ direkt unter dem Bereich „Verdächtige Ursache“ können Sie die Entwickler-Apps mit den höchsten Fehlerraten ermitteln.
Weitere Informationen zu diesem Schritt finden Sie unter Probleme identifizieren.
Schritt 4: 5xx-Benachrichtigung einrichten
Richten Sie eine Warnung basierend auf dem ausgewählten Kontext im Bereich Investigate details ein, um benachrichtigt zu werden, wenn die Anzahl der 5xx-Statuscodes einen bestimmten Grenzwert überschreitet.
Wählen Sie im rechten Bereich des Untersuchen-Dashboards die Option
> Benachrichtigung erstellen aus.
Füllen Sie die Felder im Benachrichtigungsdialogfeld aus. Die Bedingungsfelder werden vorab mit Daten aus dem aktuellen Kontext ausgefüllt. Beispiel:
Klicken Sie auf Speichern.
Wenn die 5xx-Fehlerrate für einen Zeitraum von 5 Minuten für den API-Proxy perfBenchmark_invalid_v1 5% überschreitet, wird eine Benachrichtigung an die angegebene E-Mail-Adresse gesendet und eine visuelle Warnung wird auf der Benutzeroberfläche angezeigt. Beispiel:
Weitere Informationen zu diesem Schritt finden Sie unter Einrichten von Benachrichtigungen und Benachrichtigungen.
Schritt 5: Benutzerdefinierten Bericht mit Kundendetails erstellen (optional)
Generieren Sie optional einen benutzerdefinierten Bericht, um weitere Details über den Client zu ermitteln, der die 5xx-Fehler auslöst.
Auf der Seite Berichte werden benutzerdefinierte Berichte, die basierend auf einer Benachrichtigung erstellt werden, im folgenden Format benannt: API Monitoring Generated: alert-name.
Sie haben folgende Möglichkeiten, auf den benutzerdefinierten Bericht zuzugreifen, der beim Einrichten der Benachrichtigung erstellt wird:
Wählen Sie in der linken Navigationsleiste Analysieren > Benutzerdefinierte Berichte > Berichte aus, um die Seite „Berichte“ aufzurufen. Klicken Sie in der Liste auf den Namen des Berichts: API Monitoring Generated: 5xx Alert
Klicken Sie auf die Benachrichtigung, die beim Erstellen der Benachrichtigung angezeigt wird. Beispiel:
Fügen Sie die folgenden Dimensionen hinzu:
- Entwickler-App
- Client-ID
- IP-Adresse des Clients
Wenn Sie einen Bericht aufrufen möchten, der auf einer bestimmten Entwickler-App mit einer hohen Fehlerrate basiert, fügen Sie einen Filter wie den folgenden hinzu:
and (developer_app eq 'perfBenchmarkApp0')Hinweis: Entfernen Sie in diesem Fall die Entwickler-App aus der Liste der Dimensionen.
Klicken Sie auf Speichern.
Führen Sie den Bericht aus, um Details zur Entwickler-App und zu Clients aufzurufen, die den 5xx-Statuscode auslösen.
Weitere Informationen zu diesem Schritt finden Sie unter Erstellen von benutzerdefinierten Berichten.
Schritt 6: API-Proxys in einer Sammlung gruppieren
Erstellen Sie eine Sammlung, um API-Proxys zu gruppieren, und richten Sie geeignete Warnschwellenwerte für alle Mitglieder der Gruppe ein, um Probleme schneller zu diagnostizieren.
- Wählen Sie in der Edge-Benutzeroberfläche Analysieren > API-Überwachung > Sammlungen aus, um das Sammlungen-Dashboard anzuzeigen.
- Klicken Sie auf + Sammlung.
- Wählen Sie Proxy aus.
- Wählen Sie prod aus dem Drop-down-Menü für die Umgebung aus.
- Klicken Sie auf Weiter.
- Füllen Sie die Felder im Dialogfeld für die Sammlung aus.
- Klicken Sie auf Speichern
Als Nächstes können Sie, ähnlich wie in Schritt 4, eine Warnung einrichten und die Dimension auf die oben definierte Sammlung festlegen.
Weitere Informationen zu diesem Schritt finden Sie unter Sammlungen verwalten.
Schritt 7: Beheben der 5xx-Probleme
Ergreifen Sie die entsprechenden Maßnahmen, um die 5xx-Probleme zu beheben. Basierend auf der Diagnose können Sie beispielsweise eine der folgenden Aufgaben ausführen:
- Verwenden Sie Apigee Sense, um festzustellen, ob die Spitze der Anfragen verdächtig ist, und entscheiden Sie, dass Sie die im benutzerdefinierten Bericht angegebene Client-IP-Adresse blockieren möchten.
- Fügen Sie eine Kontingentrichtlinie hinzu, um die Anzahl der Verbindungen zu beschränken, die Entwickler-Apps mit Ihrem API-Proxy über einen bestimmten Zeitraum herstellen können.
- Monetarisieren Sie Ihre API, um Entwicklern die Nutzung über eine bestimmte Anzahl von Anrufen in Rechnung zu stellen.