Analyse-Seite im Jitterbit API Manager

Einführung

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

Für weitere Informationen zur Konfiguration und Ausführung einer API siehe diese Ressourcen:

• Benutzerdefinierte APIs
• OData-APIs
• Proxy-APIs

Zugriff auf die Analyse-Seite

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

Steuerungen der Analyse-Seite

Die Analyse-Seite verfügt über Steuerungen, um die angezeigten Daten in Diagrammen zu filtern, den Zeitraum festzulegen und das Layout der Diagramme zu verwalten.

Sie können die Daten, die jedes Diagramm anzeigt, sowie den Zeitraum und die Skala des Diagramms mithilfe der Filter-Dropdowns und des Zeitraumauswählers anpassen.

Filter-Dropdowns

Die Filter-Dropdowns ermöglichen es Ihnen, spezifische Kriterien über jede Kombination von Umgebungen, APIs, Profilen, Statuscodes und Versionen anzuzeigen, wie es erforderlich ist.

Jeder Filter zeigt eine Dropdown-Liste von Kriterien an, aus der Sie ein oder mehrere Kriterien mithilfe von Kontrollkästchen auswählen können. Wenn Filter auf ein Dropdown angewendet werden, erscheint neben dem Dropdown-Label ein Zähler, der die Anzahl der aktiven Filter anzeigt.

Dies sind die verfügbaren Kriterien, nach denen gefiltert werden kann:

• 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 den Umgebungen innerhalb der Organisation angezeigt, auf die Sie Zugriff haben.

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

  Hinweis

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

• Version: Verwenden Sie das Dropdown, 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, 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, um die Gruppen der HTTP-Antwortstatuscodes auszuwählen, und wählen Sie aus Erfolg (2xx), Umleitungen (3xx), Client-Fehler (4xx) und Server-Fehler (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 in den w3.org-Definitionen der Statuscodes.

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

• Filter zurücksetzen: 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 zurückzusetzen, klicken Sie auf neben dem Filteranzahl-Abzeichen.

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

Zeitraumauswahl

Die Zeitauswahl zeigt den derzeit ausgewählten Zeitraum (zum Beispiel Letzte 1 Woche) an und ermöglicht es Ihnen, den Zeitrahmen der Analysedaten anzupassen:

Klicken Sie auf die Zeitauswahl, um einen Dialog mit zwei Registerkarten zu öffnen: Relativ und Absolut.

Relative Registerkarte

Die Relative Registerkarte bietet vordefinierte Zeiträume und einen benutzerdefinierten relativen Zeitraum-Wähler:

Wählen Sie einen der vordefinierten Zeiträume aus:

• Letzte 1 Stunde: Zeigt Analysedaten für die letzte Stunde an.

• Letzte 1 Tag: Zeigt Analysedaten für den letzten Tag an.

• Letzte 1 Woche: Zeigt Analysedaten für die letzte Woche an.

• Letzte 1 Monat: Zeigt Analysedaten für den letzten Monat an.

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

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

• Einheiten-Dropdown: Wählen Sie die Zeiteinheit aus Minuten, Stunden, Tagen, Wochen oder Monaten.

• Abbrechen: Schließen Sie den Dialog, ohne Änderungen anzuwenden.

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

Absolute Registerkarte

Die Absolute Registerkarte ermöglicht es Ihnen, einen bestimmten Datum- und Zeitbereich innerhalb der letzten 90 Tage auszuwählen. Daten außerhalb dieses Bereichs sind nicht auswählbar. API-Metriken sind für 30 Tage verfügbar, sodass Ergebnisse nur für Daten innerhalb dieses Zeitraums verfügbar sind:

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 Zeitbereich mit den folgenden Steuerelementen:

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

• Endzeitfeld: 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 den Monaten mit den linken und rechten Pfeilen.

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

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

Zusätzliche Zeitraumeinstellungen

Wenn ein Zeitraum ausgewählt und im Header angezeigt wird:

• Klicken Sie auf neben der Anzeige des Zeitraums, um den ausgewählten Zeitraum zu löschen und zum Standard zurückzukehren.

• Klicken Sie auf das Kalendersymbol neben der Anzeige des Zeitraums, um das Dialogfeld zur Auswahl des Zeitraums erneut zu öffnen.

API-Gesundheitsüberwachung

Die API-Gesundheitsüberwachung-Tabelle zeigt eine Liste von langsam laufenden oder aktiven benutzerdefinierten API Aufrufen (die innerhalb eines festgelegten Zeitrahmens stattfinden) und deren Antwortzeiten:

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

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

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

• Version: Die Version der benutzerdefinierten API (sofern angegeben).

• Dienstname: Der Name des API-Dienstes.

• Methode: Die Anforderungsmethode des API-Dienstes.

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

• API-Aufrufe: Die Gesamtzahl der Aufrufe der benutzerdefinierten API innerhalb des angegebenen Zeitrahmens.

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

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

• Maximale Antwortzeit: Die maximale Antwortzeit (in Sekunden), die für den Aufruf der benutzerdefinierten API 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 innerhalb der CSV-Datei ist ein UNIX-Zeitstempel, der konvertiert werden muss, wenn Sie ein anderes Datum- und Zeitformat verwenden möchten.

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

  • Suchen: Geben Sie einen Teil oder den gesamten Spaltennamen ein, um die Liste auf die Übereinstimmungen mit dem Text zu reduzieren.

  • Alle anzeigen: Alle Spalten sichtbar machen.

  • Verschieben: Ziehen und Ablegen, um die Position der Spalte im Verhältnis 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: Änderungen an den Spalten speichern.

  • Abbrechen und Schließen: Den Spalteneditor ohne Speichern der Änderungen schließen.

Steuerung der Diagrammanzeige

Jedes Diagramm, das in den folgenden Abschnitten beschrieben wird, 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 über die Zeit anzeigen (wie Antwortzeit (ms) und Richtlinienverstöße), exportieren die Spalten name, date und value. Diagramme, die aggregierte Daten anzeigen (wie 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 auf eine größere Ansicht zu erweitern oder es auf die Standardgröße zurückzusetzen.

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

Anrufmetriken

Anrufmetriken ist ein zusammenklappbarer Abschnitt, der mehrere Diagramme zeigt, die die API-Leistung und Nutzungsdaten anzeigen. Klicken Sie auf die Abschnittsüberschrift, um die Anzeige zu erweitern oder zu reduzieren.

Der Abschnitt enthält die folgenden Diagramme:

• Hits
• Antwortzeit (ms)
• Statuscodes
• Gesamtanrufe
• Fehleranalysen
• Nutzung des Ratenlimits auf Organisationsebene
• Richtlinienverstöße
• Methodenbezogene Einblicke

Hits

Das Hits-Diagramm zeigt die Anzahl der API-Aufrufe über die Zeit an.

Drei Zusammenfassungsabzeichen erscheinen über dem Diagramm, die jeweils einen Metrikwert für den ausgewählten Zeitraum anzeigen:

• Min: Die minimale Anzahl von Aufrufen, die in einem beliebigen Zeitraum aufgezeichnet wurde.
• Durchschnitt: Die durchschnittliche Anzahl von Aufrufen über alle Zeiträume hinweg.
• Max: Die maximale Anzahl von Aufrufen, die in einem beliebigen Zeitraum aufgezeichnet wurde.

Jeder API-Endpunkt wird durch eine separate farbige Linie dargestellt, wobei die Endpunkt-URL in der Legende angezeigt wird. Wenn mehr Endpunkte geplottet sind, als die Legende anzeigen kann, erscheint ein +N-Indikator; fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs zu sehen.

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

Antwortzeit (ms)

Das Antwortzeit (ms) Diagramm zeigt die Antwortzeiten in Millisekunden für APIs über die Zeit.

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

• Min: Die minimale Antwortzeit in Millisekunden in einem beliebigen Zeitraum.
• Durchschnitt: 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 geplottet sind, als die Legende anzeigen kann, erscheint ein +N Indikator; fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs zu sehen.

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

Statuscodes

Das Statuscodes Diagramm zeigt die Verteilung der von den APIs über die Zeit zurückgegebenen HTTP-Statuscodes.

Das Diagramm zeigt spezifische HTTP-Statuscodes für alle Antwortkategorien: Erfolg (2xx), Umleitung (3xx), Client-Fehler (4xx) und Server-Fehler (5xx). Dies ermöglicht es Ihnen, die Verteilung der Antwortcodes über die Zeit zu überwachen.

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

Gesamte Aufrufe

Das Gesamte Aufrufe Diagramm zeigt die wichtigsten APIs nach Aufrufvolumen innerhalb des ausgewählten Zeitraums.

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

Das Diagramm zeigt ein Balkendiagramm, das das relative Aufrufvolumen für jede API darstellt. Jeder API-Endpunkt wird durch eine andere Farbe in der Legende dargestellt. Wenn mehr Endpunkte geplottet sind, als die Legende anzeigen kann, erscheint ein +N Indikator; fahren Sie mit der Maus darüber, um die verbleibenden Endpunkt-URLs zu sehen.

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

Fehleranalytik

Das Fehleranalytik Diagramm zeigt die Anzahl der erfolgreichen API-Aufrufe im Vergleich zu den erfolglosen Aufrufen über die Zeit als gestapeltes Flächendiagramm.

Das Diagramm zeigt zwei Kategorien:

• Statuscodes 200-299 (Erfolg): API-Aufrufe, die eine Erfolgsantwort (2xx) oder eine Weiterleitungsantwort (3xx) zurückgegeben haben.
• Statuscodes 400-599 (Fehler): API-Aufrufe, die eine Client-Fehlerantwort (4xx) oder eine Server-Fehlerantwort (5xx) zurückgegeben haben.

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

Nutzung des Ratenlimits auf Organisationsebene

Das Diagramm zur Nutzung des Ratenlimits auf Organisationsebene zeigt die durchschnittliche Anzahl von Aufrufen pro Minute für die Organisation während jedes Zeitraums.

Fahren Sie mit der Maus über einen Datenpunkt, um ein Tooltip anzuzeigen, das das Datum und das durchschnittliche Ratenlimit für diesen Zeitraum zeigt.

Richtlinienverstöße

Das Diagramm zu den Richtlinienverstößen zeigt die Anzahl der API-Aufrufe, die aufgrund von Verstößen gegen Zugriffsregeln im Laufe der Zeit fehlgeschlagen sind.

Richtlinienverstöße werden nach Art des Fehlers kategorisiert:

• Fehlgeschlagene Authentifizierung (401): API-Aufrufe, die den HTTP-Statuscode 401 (Unauthorized) erhalten haben, was darauf hinweist, dass die Anfrage gültige Authentifizierungsdaten fehlte.
• Verstoß gegen das Ratenlimit (429): API-Aufrufe, die den HTTP-Statuscode 429 (Too Many Requests) erhalten haben, was darauf hinweist, dass die Ratenlimitgrenze überschritten wurde.

Nur Kategorien mit aufgezeichneten Daten für den ausgewählten Zeitraum erscheinen im Diagramm. Wenn während des ausgewählten Zeitraums keine Richtlinienverstöße aufgetreten sind, wird die Nachricht "Keine Daten gefunden." angezeigt.

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

Einblicke auf Methodenebene

Das Diagramm zu den Einblicken auf Methodenebene zeigt die Aufschlüsselung der API-Aufrufe nach HTTP-Methode (GET, POST, PUT oder DELETE) im Laufe der Zeit.

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 verwendet werden, um auf die APIs zuzugreifen.

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

API-Nutzer

API-Nutzer ist ein zusammenklappbarer Abschnitt, der Verbrauchsmetriken für die APIs in Ihrer Organisation anzeigt. Der Abschnitt umfasst zwei Diagramme: Apps und IP-Adressen.

Apps

Das Apps-Diagramm zeigt die wichtigsten API-Nutzer (Anwendungen) nach Aufrufvolumen innerhalb des ausgewählten Zeitraums.

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, das das relative Aufrufvolumen für jede Anwendung darstellt. Fahren Sie mit der Maus über einen Balken, um die genaue Anzahl der Aufrufe und den Namen der Anwendung anzuzeigen.

IP Addresses

Das IP-Adressen-Diagramm zeigt die wichtigsten IP-Adressen nach Aufrufvolumen innerhalb des ausgewählten Zeitraums.

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, das das relative Aufrufvolumen für jede IP-Adresse darstellt. Fahren Sie mit der Maus über einen Balken, um die genaue Anzahl der Aufrufe und die IP-Adresse anzuzeigen.