Monitoring-APIs

API-Überwachung verstehen

Objective

After completing this lesson, you will be able to lernen Sie grundlegende Konzepte der API-Überwachung kennen, um die Performance über mehrere Plattformen hinweg zu verbessern.

Einführung

Die nächste Serie von Inhalten deckt die grundlegenden Kenntnisse der Monitor-APIs in verschiedenen Plattformen ab.

OData- und SOAP-API-Protokoll

Bevor Sie die OData-/SOAP-API-Protokolle überwachen möchten, sollten Sie sicherstellen, dass Sie die Berechtigungen dafür bereits aktiviert haben.

Berechtigungseinstellungen für OData-/SOAP-API-Protokolle.

Überblick

Auf den folgenden Folien erfahren Sie mehr über die API-Protokolldetails. Um die Payload-Informationen anzuzeigen, wählen Sie in der Protokolltabelle die Drucktaste in den Spalten "HTTP" oder "REST". Sie sehen die HTTP-Payload oder die REST-Payload-Details. Die Spalte Request-ID in der Protokolltabelle kann verwendet werden, um die Request-ID für jeden aufgezeichneten OData-API-Aufruf aufzuzeichnen und anzuzeigen. Sie können Request-IDs bei Bedarf als Suchkriterien verwenden.

Das SAP-SFAPI-Audit-Protokoll zeigt Anmeldedetails, Anrufzeiten, Antwortminuten, Sitzungs-IDs und Korrelations-IDs mit Filteroptionen an.

Request

Dies ist die Anforderung von OData-API-Audioprotokollen. Sie können die Anforderungsdetails prüfen. Die Select-Klausel ist immer einfach in den Anforderungsdetails zu finden.

Das SOAP-Detailfenster zeigt den XML-Code für eine Abfrage in den SFAPI-Audit-Protokolldetails an.

Response

Das entsprechende ist das Antwortdetail. Sie können auch die Antwortdetails prüfen, um die wertvollen Informationen einfach zu erhalten.

SOAP-Detail-Antwortfenster mit XML-Daten, einschließlich Benutzerinformationen wie Land, Erstellungsdatum und Anmeldedetails.

Antwortprotokoll

Manchmal gibt es Fehler- oder Warninformationen im Schwanz der Antwort. Sie können die Ausnahme über diese Meldungen korrigieren.

Die SAP-Audit-Protokolldetails zeigen eine Warnmeldung über ein fehlendes Feld cost_center in den XML-Antwortdaten an.

SOAP-API-Header

HTTP-Request-Header in den SAP-Audit-Protokolldetails zeigen IP-Adresse und Verbindungsinformationen an.

Audit-Debug-Protokoll in Provisioning

Außerdem können Sie den Prozess und Service über das Audit-Debug-Protokoll in Provisioning überwachen. Hier müssen Sie die Sitzungs-ID eingeben, um Ausnahmen zu erhalten, die durch API-Aufrufe aus dem Serverprotokoll verursacht werden (dieselben Informationen sind in Splunk verfügbar).

Die SAP-Debug-Protokollseite zeigt eine Liste der Protokolleinträge mit IDs, Zeitstempeln und Sitzungsdetails an.

Jobs überwachen

Der Screenshot gibt uns eine weitere Möglichkeit, die APIs durch das Überwachen von Jobs in der Bereitstellung zu überwachen. Für diesen Monitor können Sie den Status des Jobstatus (Import/Export/Synchronisierung) in der Bereitstellung abrufen/herunterladen.

Seite Aufträge überwachen mit Jobtypen, Status, Einreichungszeiten und Download-Statuslinks für jeden Jobeintrag

Nachrichtenverarbeitung überwachen

Der Message-Monitor bietet einen Überblick über die auf einem Tenant verarbeiteten Messages und ermöglicht es Ihnen, die Details für einzelne Messages anzuzeigen. Sie öffnen den Nachrichtenmonitor mit folgenden Aktionen: Klicken Sie auf eine Kachel im Bereich Nachrichtenverarbeitung überwachen. Meldungen werden gemäß den Filtereinstellungen der Kachel angezeigt. Sie können steuern, welche Meldungen angezeigt werden, indem Sie den Filter ändern.

Filtereinstellungen

  • Sie können steuern, welche Meldungen angezeigt werden, indem Sie den Filter ändern.
  • Sie können Nachrichten nach Status, Zeit, Artefakt oder ID filtern.
SAP HANA Cloud Integration zeigt fehlgeschlagene Nachrichtenverarbeitungsprotokolle für Bestätigung von SAP ERP nach Employee Central an.

Integrations-Content verwalten

Der Abschnitt Integrations-Content verwalten bietet einen Überblick über Integration-Content-Artefakte, z.B. Integration-Flows, die auf dem Tenant deployt wurden. Artefakte mit dem entsprechenden Status und Typ (der Kachel) werden angezeigt. Sie können die Menge der angezeigten Artefakte anpassen, indem Sie den Filter ändern. Wenn Sie auf den Status eines Artefakts klicken, werden die Artefaktdetails im Vollseitenmodus angezeigt, und die folgenden zusätzlichen Details werden angezeigt (z.B. Verarbeitungszeit und Integration-Flow-Name).

Übersicht über den Integrations-Content

Als Ergebnis der Filtereinstellungen wird eine Liste der Integrationsartefakte in einer Tabelle mit den folgenden Attributen angezeigt:

  • Status
  • Typ
  • Artefakt
Die Schnittstelle von SAP HANA Cloud Integration zeigt den Integrationsinhaltsstatus für das generische OData-Upsert von SAP ERP in Employee Central an.

Übersicht über Sicherheitsmaterial

Der Bereich Sicherheitsmaterial verwalten bietet einen Überblick über sicherheitsbezogene Artefakte.

Um ein neues Artefakt anzulegen/zu deployen, wählen Sie Hinzufügen, und wählen Sie den Artefakttyp aus (möglich für die folgenden Artefakttypen: Credential und Known Hosts (SSH)).

Um ein vorhandenes Artefakt zu bearbeiten und erneut zu deployen, wählen Sie das Artefakt in der Tabelle aus, und wählen Sie Bearbeiten (nur für bearbeitbare Artefakte unterstützt).

Um ein Artefakt herunterzuladen, wählen Sie das Artefakt in der Tabelle aus, und wählen Sie Herunterladen (nicht verfügbar für Credentials).

Sie können ein Artefakt auch löschen (unterstützt für alle Artefakttypen außer Keystore).

Eine Liste der Sicherheitsmaterialien wird in einer Tabelle angezeigt. Für jedes Artefakt werden die folgenden Attribute angezeigt:

  • Typ
  • Status
  • Bereitgestellt von
  • Bereitgestellt am
SAP HANA Cloud Integration zeigt eine Liste der Sicherheitsmaterialien mit Namen, Typen, Status und Deployment-Details an.

HTTP-Antwortcodes

Fehlertypen, die für einen Wiederholungsversuch zulässig sindZusätzliche Hinweise
HTTP-Antwortcode 5XX (außer 500)

Der Fehler 500 wird nicht wiederhergestellt, da er auf ein Problem mit Ihrer Abfrage oder Payload zurückzuführen ist.

Hinweis 503 Service nicht verfügbar kann auftreten, wenn ein Server überlastet ist, aber auch während Wartungszeiträumen.

  • Sie sollten die Ausführung während der angegebenen Wartungsperioden vermeiden.

HTTP-Antwortcode 412

Bearbeitungsvorgänge können während der optimistischen Sperre in Backend-Transaktionen auftreten.

Dazu gehören spezifische Transaktionen in einem $batch und bestimmte Instanzen in einer Upsert-Payload mit mehreren Datensätzen.

  • Wiederholen Sie bei Batch-Vorgängen nur die fehlgeschlagenen Datensätze.
  • Schließen Sie keine erfolgreichen Bearbeitungsvorgänge in die Wiederholungs-Payload ein.
  • Versuchen Sie es bei 412 Fehlern nur maximal 1 Mal.
HTTP-Timeout-FehlerKann wiederholt werden, jedoch nur, wenn die Zeitüberschreitung Ihres Clients mit der Zeitüberschreitung der SuccessFactors-Infrastruktur von 5 Minuten übereinstimmt. Wenn Sie einen Timeout vor diesem Zeitraum wiederholen, stapeln Sie Transaktionen aufeinander und führen einen möglichen Denial-of-Service-Angriff durch.
HTTP-Verbindung zurückgesetzt und keine Antwort von Serverseite 
Ungültige SitzungDies kann auftreten, wenn ein Server ausfällt und das Lastausgleichsmodul Anforderungen auf einen neuen Server verschiebt.
HTTP 401 AntwortcodeVersuchen Sie nicht, 401 Fehler bezüglich fehlgeschlagener Authentifizierung zu wiederholen. Ihre Anmeldeinformationen werden auch beim zweiten Versuch nicht akzeptiert.
HTTP-404-AntwortcodeRessource nicht gefunden, da keine Chance auf Wiederherstellung besteht, wenn Sie etwas abfragen, das nicht vorhanden ist.
HTTP 400 Response Code (Datenprobleme)Diese können bei Bearbeitungsvorgängen auftreten, bei denen erforderliche Daten fehlen oder falsche Formate aufweisen.
 Versuchen Sie weder Anlege-/POST- noch Upsert-Operationen, bei denen das Objekt einen Schlüssel für die automatische Inkrementierung hat. Beides kann zu doppelten Daten führen.

APIs überwachen

Prozessübersicht

Diese Simulation zeigt die grundlegenden Konfigurationsschritte, die erforderlich sind, um die Konfiguration für SAP SuccessFactors Employee Central manuell einzurichten. Sie erhalten die Grundkenntnisse des OData-API-Aufrufs und der Werkzeuge. Überwachen der APIs für verschiedene Partner.

Voraussetzungen

Die folgende Konfiguration und Anpassung müssen abgeschlossen sein, bevor die Grundeinstellungen in SAP SuccessFactors implementiert werden können.

  • Zugriff auf OData SFAPI
  • Zugriff auf Audioprotokoll
  • Zugriff auf API-Tools

Ergebnis

Im Rahmen dieser Demonstration wird der Konfigurationsabschnitt in EC behandelt: Monitoring-APIs.