Analytics-Seite im Jitterbit API Manager

Einführung

Die Seite Analytics im API Manager zeigt Verbrauchs- und Leistungsmetriken für benutzerdefinierte APIs, OData-APIs und Proxy-APIs. Die Daten werden in mehreren Diagrammen angezeigt.

Weitere Informationen zum Konfigurieren und Ausführen einer API finden Sie in diesen Ressourcen:

• Benutzerdefinierte APIs
• OData-APIs
• Proxy-APIs

Zugriff auf die Analytics-Seite

Um auf die Seite Analytics zuzugreifen, verwenden Sie das Harmony-Portalmenü, um API Manager > Analytics auszuwählen.

Steuerelemente der Analytics-Seite

Die Seite Analytics verfügt über Steuerelemente zum Filtern der in Diagrammen angezeigten Daten, zum Festlegen des Zeitraums, zum Verwalten des Diagrammlayouts und zum Zugriff auf den APIM AI Assistant.

Mit den Filter-Dropdowns und dem Zeitraumwähler können die Daten angepasst werden, die jedes Diagramm anzeigt, sowie der Zeitrahmen und die Skalierung des Diagramms.

AI fragen

Klicken Sie auf AI fragen, um das Panel des APIM AI Assistant zu öffnen, in dem Sie natürlichsprachliche Eingabeaufforderungen verwenden können, um mit dem API Manager zu interagieren. Weitere Informationen finden Sie unter Jitterbit API Manager AI Assistant verwenden.

Filter-Dropdowns

Mit den Filter-Dropdowns können bestimmte Kriterien über eine beliebige Kombination von Umgebungen, APIs, Profilen, Statuscodes und Versionen angezeigt werden.

Jeder Filter zeigt eine Dropdown-Liste mit Kriterien an, aus der ein oder mehrere Kriterien mithilfe von Kontrollkästchen ausgewählt werden können. Wenn Filter auf ein Dropdown angewendet werden, wird neben der Dropdown-Bezeichnung ein Zählabzeichen angezeigt, das die Anzahl der aktiven Filter angibt.

Dies sind die verfügbaren Kriterien zum Filtern:

• Umgebung: Verwenden Sie das Dropdown, um Umgebungen auszuwählen, in denen sich die APIs befinden. Wenn keine Filter ausgewählt sind, werden alle APIs in Umgebungen innerhalb der Organisation angezeigt, auf die Zugriff besteht.

• APIs: Verwenden Sie das Dropdown, um veröffentlichte APIs innerhalb der Organisation auszuwählen. Jede API wird nur nach Name aufgelistet. Wenn keine Filter ausgewählt sind, werden alle APIs in der Organisation angezeigt, auf die Zugriff besteht. Da die Filterung dem API-Namen entspricht, kann die Auswahl einer API Ergebnisse für mehrere APIs zurückgeben, die denselben Namen über verschiedene Versionen oder Umgebungen hinweg haben. Verwenden Sie die Filter Umgebung und Version, um die Ergebnisse einzugrenzen.

  Hinweis

  Zuvor veröffentlichte APIs, die nicht mehr veröffentlicht werden, werden nicht im Dropdown APIs angezeigt. API-Protokolle für diese APIs sind auf der Seite API-Protokolle vorhanden, können aber nicht gefiltert werden.

• Version: Verwenden Sie das Dropdown-Menü, um die Versionsnummer der APIs auszuwählen. Wenn keine Filter ausgewählt sind, werden alle Versionen der APIs in der Organisation angezeigt, auf die Sie Zugriff haben.

• Methoden: Verwenden Sie das Dropdown-Menü, um HTTP-Methoden auszuwählen. Wenn keine Filter ausgewählt sind, werden alle HTTP-Methoden für die APIs in der Organisation angezeigt, auf die Sie Zugriff haben.

• Statuscodes: Verwenden Sie das Dropdown-Menü, um die HTTP-Antwortstatuscodegruppen auszuwählen. Wählen Sie aus Erfolg (2xx), Umleitungen (3xx), Clientfehler (4xx) und Serverfehler (5xx). Wenn keine Filter ausgewählt sind, werden alle HTTP-Antwortstatuscodes für APIs in den Umgebungen angezeigt, auf die Sie Zugriff haben. Weitere Informationen zu Statuscodes finden Sie unter w3.org Statuscode-Definitionen.

• Profile: Verwenden Sie das Dropdown-Menü, um die Sicherheitsprofile auszuwählen, nach denen die Protokolle gefiltert werden sollen. Das Dropdown-Menü zeigt Sicherheitsprofile an, die innerhalb der Organisation erstellt wurden.

• Filter löschen: Klicken Sie, um alle angewendeten Filter in allen Dropdown-Menüs zu entfernen. Um einzelne Filterelemente hinzuzufügen oder zu entfernen, klicken Sie auf das Kontrollkästchen neben dem Elementnamen im Dropdown-Menü. Um alle Auswahlmöglichkeiten für ein bestimmtes Filter-Dropdown-Menü zu löschen, klicken Sie auf neben dem Filter-Zählabzeichen.

• Aktualisieren: Klicken Sie auf das Aktualisierungssymbol, um die Analysedaten basierend auf den angewendeten Filtern und Suchkriterien neu zu laden.

Zeitraumwähler

Der Zeitraumwähler zeigt den aktuell ausgewählten Zeitraum an (z. B. Letzte 1 Woche) und ermöglicht es Ihnen, den Zeitrahmen der Analysedaten anzupassen:

Klicken Sie auf den Zeitraumwähler, um ein Dialogfeld mit zwei Registerkarten zu öffnen: Relativ und Absolut.

Registerkarte „Relativ"

Die Registerkarte Relativ bietet voreingestellte Zeiträume und einen benutzerdefinierten Wähler für relative Zeiträume:

Wählen Sie einen der voreingestellten Zeiträume:

• Letzte 1 Stunde: Zeigt Analysedaten der letzten Stunde an.

• Letzter 1 Tag: Zeigt Analysedaten des letzten Tages an.

• Letzte 1 Woche: Zeigt Analysedaten der letzten Woche an.

• Letzter 1 Monat: Zeigt Analysedaten des letzten Monats an.

Um einen benutzerdefinierten relativen Zeitraum zu erstellen, verwenden Sie die Steuerelemente am unteren Rand des Dialogfelds:

• Zahlenfeld: Geben Sie die Anzahl der Zeiteinheiten ein (z. B. 1, 7, 30).

• Einheits-Dropdown: Wählen Sie die Zeiteinheit aus Minuten, Stunden, Tage, Wochen oder Monate.

• Abbrechen: Schließen Sie das Dialogfeld, ohne Änderungen anzuwenden.

• Anwenden: Wenden Sie den ausgewählten Zeitraum an und schließen Sie das Dialogfeld.

Registerkarte „Absolut"

Die Registerkarte Absolut ermöglicht es Ihnen, einen bestimmten Datums- und Zeitraum innerhalb der letzten 30 Tage auszuwählen. Daten außerhalb dieses Bereichs können nicht ausgewählt werden:

Der ausgewählte Datumsbereich wird oben im Dialogfeld im Format MM/DD/YYYY, HH:mm am/pm - MM/DD/YYYY, HH:mm am/pm angezeigt.

Konfigurieren Sie den Datums- und Zeitraum mithilfe der folgenden Steuerelemente:

• Startzeit-Feld: Zeigt die Startzeit für den Bereich an. Klicken Sie auf , um zu löschen, oder klicken Sie auf , um die Zeit anzupassen.

• Endzeit-Feld: Zeigt die Endzeit für den Bereich an. Klicken Sie auf , um zu löschen, oder klicken Sie auf , um die Zeit anzupassen.

• Kalenderauswahl: Verwenden Sie den Kalender, um Start- und Enddaten auszuwählen. Navigieren Sie zwischen Monaten mithilfe der linken und rechten Pfeile.

• Abbrechen: Schließen Sie das Dialogfeld, ohne Änderungen anzuwenden.

• Anwenden: Wenden Sie den ausgewählten Datums- und Zeitraum an und schließen Sie das Dialogfeld.

Zusätzliche Zeitraumsteuerelemente

Wenn ein Zeitraum ausgewählt und in der Kopfzeile angezeigt wird:

• Klicken Sie auf neben der Zeitraumanzeige, um den ausgewählten Zeitraum zu löschen und zur Standardeinstellung zurückzukehren.

• Klicken Sie auf das Kalendersymbol neben der Zeitraumanzeige, um das Dialogfeld des Zeitraumwählers erneut zu öffnen.

API-Integritätsüberwachung

Die Tabelle API-Integritätsüberwachung zeigt eine Liste langsam laufender oder aktiver Custom-API-Aufrufe (die innerhalb eines festgelegten Zeitraums auftreten) und deren Antwortzeiten an:

• Antwortschwelle: Geben Sie die Antwortschwelle (in Sekunden) ein, um Custom-API-Aufrufe mit einer Antwortzeit gleich oder größer als die angegebene Schwelle anzuzeigen. Der Standardwert beträgt 5 Sekunden und der zulässige Mindestwert ist 1 Sekunde. Die angegebene Zahl muss eine ganze Zahl sein.

• Alle aktiven APIs: Klicken Sie, um die Anzeige innerhalb des angegebenen Zeitraums umzuschalten. Wenn diese Option deaktiviert ist, zeigt die Tabelle nur Custom-APIs an, deren Antwortzeit gleich oder größer als die angegebene Antwortschwelle ist. Wenn diese Option aktiviert ist, zeigt die Tabelle alle aktiven Custom-APIs an und das Feld Antwortschwelle ist deaktiviert.

• API-Name: Der Name der Custom-API. Um die Sortierreihenfolge von absteigend (Standard) zu aufsteigend zu ändern, klicken Sie auf die Pfeile neben dem Spaltennamen.

• Version: Die Version der Custom-API (falls angegeben).

• Dienstname: Der Name des API-Dienstes.

• Methode: Die Anfragemethode des API-Dienstes.

• API-Dienst-URL: Die API-Dienst-URL.

• API-Aufrufe: Die Gesamtzahl der Aufrufe an die Custom-API innerhalb des angegebenen Zeitraums.

• Durchschnittliche Antwortzeit (Sek.): Die durchschnittliche Antwortzeit (in Sekunden) für den Custom-API-Aufruf.

• Minimale Antwortzeit: Die minimale Antwortzeit (in Sekunden), die für den Custom-API-Aufruf aufgezeichnet wurde.

• Maximale Antwortzeit: Die maximale Antwortzeit (in Sekunden), die für den Custom-API-Aufruf aufgezeichnet wurde.

• Umgebung: Die Umgebung der API.

• Als CSV herunterladen: Klicken Sie, um die aktuellen Analysedaten basierend auf den angewendeten Filtern und Suchkriterien herunterzuladen.

  Hinweis

  Das Datumsfeld in der CSV-Datei ist ein UNIX-Zeitstempel, der konvertiert werden muss, wenn Sie ein anderes Datums- und Zeitformat verwenden möchten.

• Spalten filtern: Klicken Sie, um die Sichtbarkeit und Reihenfolge der Spalten zu ändern. Die Seitenleiste Spalten wird geöffnet.

  • Suche: Geben Sie einen Teil oder den gesamten Spaltennamen ein, um die Liste auf die entsprechenden Einträge zu reduzieren.

  • Alle anzeigen: Alle Spalten sichtbar machen.

  • Verschieben: Ziehen Sie per Drag-and-Drop, um die Position der Spalte relativ zu anderen zu ändern.

  • Ausblenden: Die Spalte ist sichtbar. Klicken Sie, um sie auszublenden.

  • Anzeigen: Die Spalte ist ausgeblendet. Klicken Sie, um sie anzuzeigen.

  • Speichern: Speichern Sie alle Änderungen an den Spalten.

  • Abbrechen und Schließen: Schließen Sie den Spalten-Editor, ohne Änderungen zu speichern.

Steuerelemente zur Diagrammanzeige

Jedes in den folgenden Abschnitten beschriebene Diagramm enthält drei Symbole in der oberen rechten Ecke:

• Als CSV herunterladen: Klicken Sie, um die Diagrammdaten als CSV-Datei herunterzuladen.

  Hinweis

  Die CSV-Spaltenstruktur variiert je nach Diagrammtyp. Diagramme, die Daten im Zeitverlauf anzeigen (z. B. Antwortzeit (ms) und Richtlinienverletzungen), exportieren die Spalten name, date und value. Diagramme, die aggregierte Daten anzeigen (z. B. Apps und IP-Adressen), exportieren nur die Spalten name und value, da diese Diagramme nicht nach Datum gruppiert sind.

• Erweitern/Reduzieren: Klicken Sie, um das Diagramm in einer größeren Ansicht zu erweitern oder es auf seine Standardgröße zu reduzieren.

• Ziehen: Klicken Sie und ziehen Sie, um das Diagramm auf der Seite zu verschieben.

Aufrufsmetriken

Aufrufsmetriken ist ein ausklappbarer Bereich, der mehrere Diagramme mit API-Leistungs- und Nutzungsdaten anzeigt. Klicken Sie auf die Überschrift des Bereichs, um die Anzeige zu erweitern oder zu reduzieren.

Der Bereich enthält die folgenden Diagramme:

• Hits
• Antwortzeit (ms)
• Statuscodes
• Gesamtaufrufe
• Fehleranalyse
• Auslastung der Ratenbegrenzung auf Organisationsebene
• Richtlinienverletzungen
• Erkenntnisse auf Methodenebene

Hits

Das Diagramm Hits zeigt die Anzahl der API-Aufrufe im Zeitverlauf an.

Über dem Diagramm werden drei Zusammenfassungs-Badges angezeigt, die jeweils einen Metrikwert für den ausgewählten Zeitraum anzeigen:

• Min: Die minimale Anzahl der in einem beliebigen Zeitraum erfassten Aufrufe.
• Average: Die durchschnittliche Anzahl der Aufrufe über alle Zeiträume hinweg.
• Max: Die maximale Anzahl der in einem beliebigen Zeitraum erfassten Aufrufe.

Jeder API-Endpunkt wird durch eine separate farbige Linie dargestellt, wobei die Endpunkt-URL in der Legende angezeigt wird. Wenn mehr Endpunkte dargestellt werden, als die Legende anzeigen kann, wird ein +N-Indikator angezeigt. Fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs anzuzeigen.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um eine Tooltip anzuzeigen, die das Datum und die Anzahl der Aufrufe für diesen Endpunkt zu diesem Zeitpunkt anzeigt.

Response time (ms)

Das Diagramm Response time (ms) zeigt die Antwortzeiten in Millisekunden für APIs im Zeitverlauf an.

Das Diagramm zeigt drei Metriken, die als Badges über dem Diagramm angezeigt werden:

• Min: Die minimale Antwortzeit in Millisekunden in einem beliebigen Zeitraum.
• Average: Die durchschnittliche Antwortzeit in Millisekunden über alle Zeiträume hinweg.
• Max: Die maximale Antwortzeit in Millisekunden in einem beliebigen Zeitraum.

Jeder API-Endpunkt wird durch eine separate farbige Linie dargestellt, wobei die Endpunkt-URL in der Legende angezeigt wird. Wenn mehr Endpunkte dargestellt werden, als die Legende anzeigen kann, wird ein +N-Indikator angezeigt. Fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs anzuzeigen.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um die Antwortzeit in Millisekunden für diesen Endpunkt zu diesem bestimmten Zeitpunkt anzuzeigen.

Status codes

Das Diagramm Status codes zeigt die Verteilung der von den APIs zurückgegebenen HTTP-Statuscodes im Zeitverlauf an.

Das Diagramm zeigt spezifische HTTP-Statuscodes für alle Antwortkategorien: Erfolg (2xx), Umleitung (3xx), Clientfehler (4xx) und Serverfehler (5xx). Dies ermöglicht es, die Verteilung der Antwortcodes im Zeitverlauf zu überwachen.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um eine Tooltip anzuzeigen, die das Datum und die Anzahl der Aufrufe anzeigt, die zu diesem Zeitpunkt jeden Statuscode zurückgegeben haben.

Total calls

Das Diagramm Total calls zeigt die Top-APIs nach Aufruflautstärke innerhalb des ausgewählten Zeitraums an.

Verwenden Sie das Dropdown-Menü oben rechts, um auszuwählen, welche APIs angezeigt werden sollen. Die Optionen umfassen Top 5 APIs, Top 10 APIs, Top 25 APIs und All APIs.

Das Diagramm zeigt ein Balkendiagramm mit der relativen Aufruflautstärke für jede API. Jeder API-Endpunkt wird durch eine andere Farbe in der Legende dargestellt. Wenn mehr Endpunkte dargestellt werden, als die Legende anzeigen kann, wird ein +N-Indikator angezeigt. Fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs anzuzeigen.

Fahren Sie mit der Maus über einen beliebigen Balken, um eine Tooltip anzuzeigen, die die Endpunkt-URL und die Aufrufe anzeigt.

Error Analytics

Das Diagramm Error Analytics zeigt die Anzahl der erfolgreichen API-Aufrufe im Vergleich zu fehlgeschlagenen Aufrufen im Zeitverlauf als gestapeltes Flächendiagramm an.

Das Diagramm zeigt zwei Kategorien:

• Status codes 200-299 (success): API-Aufrufe, die eine erfolgreiche (2xx) oder Umleitungs- (3xx) Antwort zurückgegeben haben.
• Status codes 400-599 (errors): API-Aufrufe, die eine Clientfehler- (4xx) oder Serverfehler- (5xx) Antwort zurückgegeben haben.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um eine Tooltip anzuzeigen, die die Zeit und die Anzahl der Aufrufe für diese Kategorie zu diesem Zeitpunkt anzeigt.

Org level rate limit utilization

Das Diagramm Org level rate limit utilization zeigt die durchschnittliche Anzahl der Aufrufe pro Minute für die Organisation während jedes Zeitraums an.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um eine Tooltip anzuzeigen, die das Datum und das durchschnittliche Ratenlimit für diesen Zeitraum anzeigt.

Policy violations

Das Diagramm Policy violations zeigt die Anzahl der API-Aufrufe an, die aufgrund von Zugriffsverletzungen im Zeitverlauf fehlgeschlagen sind.

Richtlinienverletzungen werden nach Art des Fehlers kategorisiert:

• Failed Authentication (401): API-Aufrufe, die den HTTP-Statuscode 401 (Unauthorized) erhalten haben, was darauf hinweist, dass der Anfrage gültige Authentifizierungsanmeldeinformationen fehlten.
• Rate Limit Violation (429): API-Aufrufe, die den HTTP-Statuscode 429 (Too Many Requests) erhalten haben, was darauf hinweist, dass der Ratenlimit-Schwellenwert überschritten wurde.

Nur Kategorien mit erfassten Daten für den ausgewählten Zeitraum werden im Diagramm angezeigt. Wenn während des ausgewählten Zeitraums keine Richtlinienverletzungen aufgetreten sind, wird die Meldung „No data found." angezeigt.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um einen Tooltip mit dem Datum und der Anzahl der Verstöße für diese Kategorie zu diesem Zeitpunkt anzuzeigen.

Erkenntnisse auf Methodenebene

Das Diagramm Erkenntnisse auf Methodenebene zeigt die Aufschlüsselung der API-Aufrufe nach HTTP-Methode (GET, POST, PUT oder DELETE) im Zeitverlauf.

Das Diagramm zeigt jede HTTP-Methode mit einer anderen Farbe in der Legende. Dies ermöglicht es Ihnen zu analysieren, welche Methoden am häufigsten für den Zugriff auf die APIs verwendet werden.

Fahren Sie mit der Maus über einen beliebigen Datenpunkt, um die Anzahl der Aufrufe für diese Methode während des Zeitraums anzuzeigen.

API-Consumer

API-Consumer ist ein ausklappbarer Bereich, der Verbrauchsmetriken für die APIs in Ihrer Organisation anzeigt. Der Bereich enthält zwei Diagramme: Apps und IP-Adressen.

Apps

Das Diagramm Apps zeigt die Top-API-Consumer (Anwendungen) nach Aufruflautstärke im ausgewählten Zeitraum.

Verwenden Sie das Dropdown-Menü, um die Anzahl der anzuzeigenden Apps auszuwählen. Die Optionen umfassen Top 5 Apps, Top 10 Apps, Top 25 Apps und Alle Apps.

Das Diagramm zeigt ein Balkendiagramm mit der relativen Aufruflautstärke für jede Anwendung. Fahren Sie mit der Maus über einen beliebigen Balken, um die genaue Anzahl der Aufrufe und den Namen der Anwendung anzuzeigen.

IP-Adressen

Das Diagramm IP-Adressen zeigt die Top-IP-Adressen nach Aufruflautstärke im ausgewählten Zeitraum.

Verwenden Sie das Dropdown-Menü, um die Anzahl der anzuzeigenden IP-Adressen auszuwählen. Die Optionen umfassen Top 5 IP-Adressen, Top 10 IP-Adressen, Top 25 IP-Adressen und Alle IP-Adressen.

Das Diagramm zeigt ein Balkendiagramm mit der relativen Aufruflautstärke für jede IP-Adresse. Fahren Sie mit der Maus über einen beliebigen Balken, um die genaue Anzahl der Aufrufe und die IP-Adresse anzuzeigen.

Fehlerbehebung

Weitere Informationen zur Fehlerbehebung finden Sie in den folgenden Abschnitten im API Manager-Fehlerbehebungsleitfaden:

• Unveröffentlichte APIs werden nicht in der Dropdown-Liste „Analytics APIs" angezeigt