Zum Inhalt springen

Betrieb-Debug-Protokollierung für Jitterbit-private Agenten

Einführung

Die Betrieb-Debug-Protokollierung erzeugt zusätzliche diagnostische Informationen zur Unterstützung bei der Fehlersuche. Diese Funktion produziert drei Arten von Protokollen:

  • Betrieb-Debug-Protokolldateien: Debug-Nachrichten für jede Betriebsaktivität, einschließlich Informationen, die vor und nach der Ausführung jeder Transformation protokolliert werden. Die Dateien werden auf dem privaten Agenten geschrieben und unterliegen der Aufbewahrungsrichtlinie, die in den Bereinigungsregeln des Agenten konfiguriert ist (standardmäßig 1 Tag).

  • Komponenten-Eingangs- und Ausgangsdaten: Die Anforderungs- und Antwortdaten, die von jeder Aktivität und Transformation in einem Betrieb verarbeitet werden. Diese Daten sind für Operationen verfügbar, die auf privaten Agenten der Version 10.48 oder höher ausgeführt werden. Harmony behält diese Daten 30 Tage lang.

  • API-Anforderungsdaten: Detaillierte Informationen zu API-Aufrufen für Operationen, die von einem API-Manager benutzerdefinierten API oder OData-API ausgelöst werden, einschließlich API-Name, Anforderungsmethode, Quell-IP, Gateway-Details und Anrufverfolgungsdaten. Für Details, wann diese Daten in Protokollen erscheinen, siehe API-Anforderungsdaten.

Warnung

Wenn Komponenten-Eingangs- und Ausgangsdaten generiert werden, werden alle Anforderungs- und Antwortdaten für diesen Betrieb in der Harmony-Cloud protokolliert und bleiben dort 30 Tage lang. Personenbezogene Daten (PII) und sensible Daten wie Anmeldeinformationen, die in einer Anforderungsnutzlast bereitgestellt werden, sind im Klartext in den Eingangs- und Ausgangsdaten innerhalb der Harmony-Cloud-Protokolle sichtbar.

Aufgrund dieser Sicherheitsimplikationen sollte die Betrieb-Debug-Protokollierung nur zur Fehlersuche bei Problemen während der Tests verwendet werden. Aktivieren Sie diese Funktion nicht in einer Produktionsumgebung. Generierte Debug-Protokolldateien können in Menge und/oder Größe groß sein.

Hinweis

Die Schritte zur Aktivierung der Protokollierung aller API-Operationen für den gesamten Agenten unterscheiden sich von den in Gesamter privater Agent weiter unten auf dieser Seite beschriebenen Schritten. Informationen zur Aktivierung der API-Betriebsprotokollierung für den gesamten Agenten finden Sie unter API Operation.

Aktivieren des Debug-Protokollierens von Operationen

Das Debug-Protokollieren von Operationen kann für eine einzelne Operation oder für einen gesamten privaten Agenten aktiviert werden. Eingabe- und Ausgabedaten von Komponenten werden standardmäßig auf privaten Agenten der Version 10.48 oder höher generiert, können jedoch mithilfe von zusätzlichen Einstellungen in der Konfigurationsdatei des privaten Agenten deaktiviert werden.

Einzelne Operation

Das Debug-Protokollieren auf Operationsebene kann hilfreich sein, wenn Sie Probleme mit einer einzelnen Operation haben und das Debug-Protokollieren auf Agentenebene nicht aktivieren möchten, da dies möglicherweise Dateien in großer Anzahl und/oder Größe erzeugt.

Sie können das Debug-Protokollieren für eine einzelne Operation entweder über die Studio-Operationsoptionen oder die Design-Studio-Operationsoptionen aktivieren:

  • Studio: Verwenden Sie das Aktionsmenü einer Operation, um Einstellungen auszuwählen. Im Tab Optionen wählen Sie Debug-Protokollierung aktivieren bis und setzen ein Datum, an dem die Debug-Protokollierung deaktiviert werden soll. Die Option, die Debug-Modus-Einstellungen auf alle untergeordneten Operationen zu übertragen, ist ebenfalls verfügbar.

  • Design Studio: Klicken Sie mit der rechten Maustaste auf den Hintergrund einer beliebigen Operation und wählen Sie Optionen. Im Fenster Operationsoptionen wählen Sie Debug-Modus aktivieren bis und setzen ein Datum, an dem die Debug-Protokollierung deaktiviert werden soll.

Dieses Datum ist auf 2 Wochen ab dem aktuellen Datum begrenzt. Das Debug-Protokollieren von Operationen wird zu Beginn dieses Datums (d. h. um 00:00 Uhr) unter Verwendung der Zeitzone des Agenten deaktiviert.

Gesamter privater Agent

Das Debug-Protokollieren von Operationen auf Agentenebene kann über die Konfigurationsdatei des privaten Agenten für alle Operationen, die auf einem privaten Agenten ausgeführt werden, aktiviert werden.

Vorsicht

Das Aktivieren der Debug-Protokollierung auf Agentenebene kann sehr große Dateien im Verzeichnis jedes privaten Agenten innerhalb der Gruppe privater Agenten erstellen. Wenn Sie Probleme mit einer einzelnen Operation haben, ziehen Sie in Betracht, das Debug-Protokollieren für eine einzelne Operation stattdessen zu aktivieren.

Um das Debug-Logging zu aktivieren, bearbeiten Sie die private Agent-Konfigurationsdatei wie folgt und starten Sie dann die Jitterbit-Dienste neu.

  • Unter dem Abschnitt [TransformationEngine] setzen Sie WriteLog=true.

  • Unter dem Abschnitt [OperationEngine] setzen Sie Debug=true.

Die in diesem Verzeichnis erstellten Dateien können sehr groß werden. Deaktivieren Sie das Debug-Logging, sobald Sie können, und löschen Sie die Dateien, wenn sie nicht mehr benötigt werden.

Zusätzliche Einstellungen

Private Agenten, die Version 10.48 und höher sind, haben den Abschnitt [VerboseLogging] in ihrer privaten Agent-Konfigurationsdatei mit der Einstellung verbose.logging.enable=true, die die Generierung von Eingangs- und Ausgangsdaten der Komponenten aktiviert:

[VerboseLogging]
verbose.logging.enable=true

Beim Upgrade einer früheren Version des privaten Agenten auf 10.48 oder höher wird die Generierung von Eingangs- und Ausgangsdaten standardmäßig automatisch aktiviert, auch wenn der Abschnitt [VerboseLogging] und die Einstellung verbose.logging.enable nicht in der Konfigurationsdatei vorhanden sind.

Um die Generierung von Eingangs- und Ausgangsdaten der Komponenten zu deaktivieren, müssen Sie den Abschnitt [VerboseLogging] hinzufügen und verbose.logging.enable=false setzen, um zu verhindern, dass Eingangs- und Ausgangsdaten der Komponenten in die Harmony-Cloud protokolliert werden.

Zusätzliche Einstellungen im Abschnitt [VerboseLogging] sollten nicht geändert werden, es sei denn, Jitterbit-Support weist darauf hin.

Protokolle der Operation anzeigen

Der Ort, an dem Sie die Protokolle der Operation anzeigen, hängt von der Art des generierten Protokolls ab:

  • Protokolldateien für das Operation-Debug: Zugriff über das Agent-Protokolle herunterladen-Symbol auf der Management Console Agenten-Seite, den Tab Debug-Dateien der Management Console Runtime-Seite oder direkt auf dem Agenten-Host. Für Details siehe Zugriff auf Protokolldateien.

  • Eingangs- und Ausgangsdaten der Komponenten sowie API-Anforderungsdaten: Ansicht in den Studio-Protokollen der Operation über das Menü Protokolle anzeigen oder auf der Management Console Runtime-Seite.

Betrieb Debug-Protokolldateien

Sobald das Debug-Protokollieren von Operationen für eine Studio-Operation, eine Design Studio-Operation oder einen gesamten privaten Agenten aktiviert ist, werden für die entsprechenden Operationen Debug-Protokolldateien erstellt, wenn diese Operationen ausgeführt werden.

Zugriff auf Debug-Protokolldateien

Debug-Protokolldateien für Operationen können über das Agentenprotokolle herunterladen-Symbol auf der Management Console Agenten-Seite, den Tab Debug-Dateien der Management Console Laufzeit oder direkt auf dem Agenten-Host an den folgenden Orten zugegriffen werden:

C:\Program Files\Jitterbit Agent\DataInterchange\Temp\Debug

/usr/local/jitterbit/DataInterchange/Temp/Debug

Um das Verzeichnis für die Debug-Protokolldateien zu ändern, bearbeiten Sie die Konfigurationsdatei des privaten Agenten wie folgt und starten Sie dann die Jitterbit-Dienste neu:

  • Unter dem Abschnitt [TransformationEngine] setzen Sie WriteLogDir auf den gewünschten Verzeichnispfad.

Aufbewahrungsrichtlinie für Debug-Protokolldateien

Standardmäßig werden Debug-Protokolldateien für Operationen automatisch nach 1 Tag gelöscht.

Dieser Zeitraum kann in CleanupRules.xml konfiguriert werden, die auf privaten Agenten an diesen Standardstandorten zugänglich ist:

C:\Program Files\Jitterbit Agent

/usr/local/jitterbit/

Innerhalb der Datei CleanupRules.xml können Sie diese Bereinigungsregel bearbeiten, um die Aufbewahrungsrichtlinie für Debug-Protokolldateien zu ändern:

  <CleanupRule>
      <DirectoryPath SearchSubDirectory = "YES" >DataInterchange/Temp/Debug</DirectoryPath>
      <Pattern>*</Pattern>
      <FileAge NumDays = "1" Comparator = "GE"/>
      <FileSize Size = "0" Comparator = "GE"/>
  </CleanupRule>

Inhalt der Debug-Protokolldateien

Debug-Protokolldateien für Operationen enthalten Debug-Nachrichten für jede Betriebsaktivität und beinhalten Informationen, die vor und nach der Ausführung jeder Transformation protokolliert werden. Informationen über andere Aktionen wie das Lesen von und Schreiben in den Harmony-Cache sind ebenfalls enthalten.

Diese Dateien werden typischerweise von Jitterbit-Support angefordert, wenn während der Fehlersuche weitere Informationen benötigt werden.

Komponenteneingabe- und -ausgabedaten

Voraussetzungen

Komponenteneingabe- und -ausgabedaten werden generiert, wenn alle folgenden Bedingungen erfüllt sind:

Vorsicht

Die Generierung von Komponenteneingabe- und -ausgabedaten wird nicht durch die Agentengruppeinstellung Cloud-Protokollierung aktiviert beeinflusst. Komponenteneingabe- und -ausgabedaten werden in der Harmony-Cloud protokolliert, selbst wenn die Cloud-Protokollierung deaktiviert ist.

Um die Generierung von Komponenteneingabe- und -ausgabedaten für eine Agentengruppe zu deaktivieren, setzen Sie in der Konfigurationsdatei des privaten Agenten im Abschnitt [VerboseLogging] verbose.logging.enable=false.

Eingabe- und Ausgabedaten

Eingabe- und Ausgabedaten sind nur für Aktivitäten und Transformationen verfügbar, die als Operation-Schritte verwendet werden.

Komponenteneingabe- und -ausgabedaten können über den Studio Protokollbildschirm der Operation oder die Seite Laufzeit der Management-Konsole in zusätzlichen Tabellenzeilen angezeigt werden, die für jeden Operation-Schritt mit Eingabe- und Ausgabedaten angezeigt werden. Im linken Bereich werden Symbole für Aktivitäten und Transformationen angezeigt, die als Operation-Schritte verwendet werden. Sie können auf einen Operation-Schritt klicken, um die Komponenteneingabe- und -ausgabedaten für diesen einzelnen Operation-Schritt anzuzeigen oder auszublenden. Jeder Eingabe- und Ausgabeeintrag ist auf 100 MB begrenzt. Wenn die Daten für einen einzelnen Eingabe- oder Ausgabeeintrag 100 MB überschreiten, werden keine Daten angezeigt.

logs table operation steps header

  • Suchen: Suchen Sie die Daten nach dem eingegebenen Text.
  • Kopieren: Kopiert die Protokolldaten in Ihre Zwischenablage.
  • Herunterladen: Lädt die Eingabe- oder Ausgabedaten herunter. Die Datei wird mit dem Namen des Operation-Schrittes gefolgt von _input oder _output benannt, je nach Bedarf.

Eingabe- und Ausgabedatenaufbewahrungsrichtlinie

Die Eingabe- und Ausgabedaten der Komponenten werden von Harmony 30 Tage lang aufbewahrt.

Eingabe- und Ausgabedateninhalte

Eingabe- und Ausgabedaten der Komponenten werden für bestimmte Schritte eines Vorgangs generiert. Die Daten sind entsprechend der Funktion eines Schrittes geeignet. Die Eingabe ist die Struktur, die die Komponente konsumiert, während die Ausgabe die Struktur ist, die die Komponente produziert.

Eingabe- und Ausgabedaten werden für diese Komponenten generiert, die als operationale Schritte verwendet werden:

  • Aktivitäten: Eingabe- und Ausgabedaten sowie alle zugehörigen Informationen für die Ausführung der Aktivität. Einige Aktivitäten können mehrere Eingabe- und Ausgabedateien haben.

  • Transformationen: Eingabe- und Ausgabedaten für die Ausführung der Transformation.

Eingabe- und Ausgabedaten sind nicht anwendbar auf Skripte, wenn Sie diese als operationale Schritte verwenden. Der Inhalt des Skripts, wie er durch die Funktion WritetoOperationLog erzeugt wird, wird in den Protokollnachrichten eines Vorgangsprotokolls angezeigt.

Eingabe- und Ausgabedaten-Fehlerbehebung

Agentenprotokolle, die sich auf die Eingabe- und Ausgabedaten beziehen, sollten normalerweise nicht benötigt werden. Wenn Sie denken, dass es ein Problem mit der Generierung der Eingabe- und Ausgabedaten geben könnte, können Sie die Protokolldateien des Verbose Log Shipper-Dienstes auf einem privaten Agenten überprüfen:

<JITTERBIT_HOME>/VerboseLogShipper/verbose-log-shipper.out.log

Der Verbose Log Shipper-Dienst kann durch einen Neustart eines privaten Agenten neu gestartet werden.

Bei Linux-Privatagenten können Sie diesen Dienst auch deaktivieren und wieder aktivieren, indem Sie diese Jitterbit-Befehlszeilenoptionen verwenden:

jitterbit start verboselogshipper

jitterbit stop verboselogshipper

Diese Optionen können auch mit jitterbit --help angezeigt werden.

API-Anforderungsdaten

Neue Analytics-Oberfläche erforderlich

Die Funktion für API-Anforderungsdaten ist nur für Organisationen verfügbar, die auf die neue Analytics -Oberfläche aktualisiert wurden. Dieses Upgrade wird schrittweise eingeführt. Wenn Sie an einem frühen Zugang interessiert sind, kontaktieren Sie Jitterbit-Support.

Wenn eine Operation durch einen API-Manager benutzerdefinierte API oder OData-API ausgelöst wird, hängt die Menge der in den Betriebsprotokollen angezeigten Informationen von den aktivierten Einstellungen ab:

Aktivierte Einstellungen Protokollierte Informationen So aktivieren Sie es
Keine (Standard)
  • Nur erfolglose Operationen im Studio Betriebsprotokolle.
  • Sowohl erfolgreiche als auch erfolglose Operationen mit API-Anforderungsinformationen auf der Seite Laufzeit der Management-Konsole.
 Dies ist das Standardverhalten.
Betrieb-Debug-Protokollierung Sowohl erfolgreiche als auch erfolglose Operationen mit API-Anforderungsinformationen in den Studio Betriebsprotokollen und auf der Seite Laufzeit der Management-Konsole. Anforderungs- und Antwortpayload sind ausgeschlossen.
Betrieb-Debug-Protokollierung und API-Detailprotokollierung Sowohl erfolgreiche als auch erfolglose Operationen mit API-Anforderungsinformationen in den Studio Betriebsprotokollen und auf der Seite Laufzeit der Management-Konsole, einschließlich Anforderungs- und Antwortpayload. Aktivieren Sie die Betrieb-Debug-Protokollierung für Cloud-Agenten oder private Agenten, und aktivieren Sie in API-Manager die Detailprotokollierung im Einstellungs-Tab der API.

api information

API-Information

Das Betriebsprotokoll kann die folgenden Informationen zu API-Aufrufen anzeigen:

  • API-Informationen: Details zum API-Aufruf, einschließlich API-Name, API-Typ, Anforderungsmethode, API-Anforderungs-ID, Quell-IP, API-Gateway, API-Dienst-URL und Quellanwendung. Für Feldbeschreibungen siehe API-Informationen.

  • Aufrufinformationen: Die HTTP-Anforderungsheader, die mit dem API-Aufruf gesendet wurden, wie accept, accept_encoding, content_length, fulluri, host, user_agent und Weiterleitungsheader.

  • Aufrufprotokoll: Verfolgungsinformationen zur Verarbeitung der API-Anforderung.