Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Mit benutzerdefinierten Berichten können Sie einen Drilldown in bestimmte API-Metriken durchführen und genau die Daten anzeigen, die Sie anzeigen möchten. In den API-Monitoring-Dashboards können Sie einen benutzerdefinierten Bericht mit der Filter- und Messwertvoreinstellung erstellen, die auf den zum Zeitpunkt der Erstellung konfigurierten Bedingungen basiert. Darüber hinaus wird im Bericht eine Reihe von Standarddimensionen und -messwerten für Sie konfiguriert.
Benutzerdefinierten Bericht basierend auf Ihrem Kontext erstellen
Erstellen Sie schnell benutzerdefinierte Berichte basierend auf Ihrem Kontext, wie in der folgenden Tabelle zusammengefasst. Auf der Seite Benutzerdefinierte Berichte werden benutzerdefinierte Berichte, die mit der API-Überwachung erstellt werden, standardmäßig eindeutig benannt, wie in der Tabelle angegeben. Sie können den Namen ändern, wenn Sie den benutzerdefinierten Bericht bearbeiten.
| Kontext des benutzerdefinierten Berichts | Standardbenennungskonvention für benutzerdefinierte Berichte |
|---|---|
| Letztes Dashboard | API Monitoring Recent Generated |
| Zeitachsen-Dashboard | API Monitoring Timeline Generated |
| Dashboard untersuchen | API Monitoring Investigate Generated |
| Benachrichtigungsbedingung | API Monitoring Generated: alert-name |
Standarddimension und -messwerte
Der benutzerdefinierte Bericht enthält standardmäßig die in der folgenden Tabelle aufgeführten Dimensionen und Messwerte für alle von der API-Überwachung generierten Berichte.
| Komponente | Standardeinstellungen |
|---|---|
| Abmessungen | Anfrage-URI |
| Messwerte |
|
Benutzerdefinierten Bericht bearbeiten
Wie im vorherigen Abschnitt erwähnt, sind vordefinierte Standarddimensionen und -messwerte für die API-Überwachung in benutzerdefinierten Berichten vorkonfiguriert. Nachdem er erstellt wurde, können Sie den benutzerdefinierten Bericht bearbeiten, um bei Bedarf Messwerte und Dimensionen hinzuzufügen oder zu löschen. Sie können Ihre Untersuchung beispielsweise auf ein bestimmtes Zugriffstoken, eine Entwickler-App, einen API-Proxy oder eine Anfrage-ID eingrenzen.
Im folgenden benutzerdefinierten Bericht fügen Sie die vordefinierte Gateway Flow ID-Dimension hinzu, wobei Gateway Flow ID die eindeutige UUID jeder an Edge gestellten API-Anfrage enthält.
Beachten Sie, dass der Bericht bereits die Dimension Request URI verwendet:
Im folgenden Beispiel wird dem benutzerdefinierten Bericht die Dimension Client ID hinzugefügt.
Die Dimension Client ID enthält den Consumer-Schlüssel (API-Schlüssel) des Entwicklers, der den API-Aufruf durchführt, unabhängig davon, ob er in der Anfrage als API-Schlüssel übergeben oder in einem OAuth-Token enthalten ist:
Der benutzerdefinierte Bericht enthält Informationen zu allen Client ID-Werten.
Im nächsten Beispiel wird ein Filter hinzugefügt, mit dem Sie einen benutzerdefinierten Bericht für eine bestimmte Client ID erstellen können:
Weitere Informationen zu allen vordefinierten Dimensionen und Messwerten, die Sie einem Bericht hinzufügen können, finden Sie unter Referenz zu Analytics-Metriken, -Dimensionen und -Filtern.
Im nächsten Beispiel fügen Sie einem benutzerdefinierten Bericht einen Filter hinzu, der die Standardmetriken und -dimensionen für den Fehlercode policies.ratelimit.QuotaViolation und die 5xx-Statuscodes erfasst:
Ausführliche Informationen zum Bearbeiten eines benutzerdefinierten Berichts finden Sie unter Verwalten von benutzerdefinierten Berichten.
Beispiel: Bereitstellungsprobleme mithilfe von benutzerdefinierten Berichten diagnostizieren
Hängen Sie die StatisticsCollector-Richtlinie an Ihre API-Proxys an, um benutzerdefinierte Analysedaten wie Benutzer- oder Produkt-ID, Preis, REST-Aktion, Zielversion, Ziel-URL und Nachrichtenlänge zu erfassen. Die Daten können aus von Apigee vordefinierten Flussvariablen, Anfrageheadern, Abfrageparametern oder von Ihnen definierten benutzerdefinierten Variablen stammen.
Anfragen an Ihren API-Proxy enthalten beispielsweise Header für die Produkt-ID, die Nutzer-ID und die Version des Zielservers. Diese Anfrage könnte das folgende Format haben:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Anhand der Informationen in den Headern können Sie dann Laufzeitprobleme bei Ihrem API-Proxy diagnostizieren.
So erstellen Sie einen benutzerdefinierten Bericht für diese Überschriften:
Fügen Sie Ihrer API die StatisticsCollector-Richtlinie hinzu, um den Wert der benutzerdefinierten Header zu erfassen:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Stellen Sie Ihren Proxy bereit und warten Sie, bis er darauf zugreifen kann.
Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > API-Überwachung > Zuletzt, um alle Probleme mit Ihrer API anzuzeigen. Sie erhalten 4xx- und 5xx-Fehler für den myapi-Proxy:
Wählen Sie die myapi-Proxyzeile aus, um weitere Details im rechten Bereich des Dashboards „Zuletzt“ anzuzeigen.
Wählen Sie im rechten Bereich des Dashboards Zuletzt aus
> In Investigate anzeigen, um auf das Investigate-Dashboard zuzugreifen:
Filtern Sie das Investigate-Dashboard nach dem myapi-Proxy und sehen Sie sich dann den Statuscode im oberen Diagramm an. Sie erhalten 403- und 501-Fehler:
Wählen Sie in der Edge-Benutzeroberfläche Analytics > Benutzerdefinierte Berichte > Berichte aus, um einen benutzerdefinierten Bericht zu erstellen, der die Werte dieser benutzerdefinierten Messwerte als Dimension enthält.
Wählen Sie + Benutzerdefinierter Bericht aus, um einen benutzerdefinierten Bericht mit dem Namen myapi_errors zu erstellen.
Wählen Sie Proxy-Fehler als Messwert aus und setzen Sie die Aggregatfunktion auf Summe. Bei Bedarf können Sie weitere Messwerte hinzufügen.
Wählen Sie die vordefinierte Dimension Antwortstatuscode aus und fügen Sie den Dimensionen die drei benutzerdefinierten Statistiken prodid, targetersion und userid hinzu:
Legen Sie den Filter so fest, dass nur Daten für den myapi-API-Proxy
(apiproxy eq 'myapi')eingeschlossen werden:
Speichern Sie den Bericht.
Erstellen Sie den Bericht für die letzten 24 Stunden. Wenn der Bericht zum ersten Mal geöffnet wird, sehen Sie ein Diagramm mit HTTP-403- und 501-Fehlern:
Klicken Sie unter Zusammenfassung auf 403 oder 510, um zu sehen, welches Produkt die Fehler generiert. Sie wählen beispielsweise 403 aus:
Klicken Sie unter Zusammenfassung auf eine Produkt-ID, um die Fehler nach Zielversion (Alpha oder Beta) aufgeschlüsselt anzuzeigen:
Klicken Sie unter Zusammenfassung auf eine Zielversion, um die Fehler nach Nutzer aufgeschlüsselt anzuzeigen:
