Protokollierungs- und Protokollstufen

Während der Prozessausführung generiert der Roboter für jeden Schritt eine Nachricht (Protokoll). Diese werden gesammelt und in einer Protokolldatei gespeichert. Der gesamte Vorgang zum Sammeln und Speichern der Protokolle wird als Protokollierung bezeichnet.

Jedes Protokoll verfügt über eine Protokollebene, die sich darauf bezieht, wie detailliert die generierte Nachricht ist.

Protokollierungsebenen beziehen sich auf den Schweregradtyp, der in der Protokolldatei angegeben ist.

Protokollierungsstufen in UiPath

Die Protokollebene bezieht sich darauf, wie detailliert die generierte Nachricht sein soll. Sie können sie konfigurieren über:

• die Einstellung Protokollebene unter Assistant > Einstellungen > Seite Allgemein. Standardmäßig ist dies auf Information festgelegt.
• die Einstellung Protokollierungsstufe unter Orchestrator > Zugriff verwalten > Benutzer > „Benutzer- oder Roboterkonto“ > Seite Robotereinstellungen. Standardmäßig ist dies auf Information festgelegt.
  Hinweis: Die Protokollebene, die Sie im Orchestrator festlegen, überschreibt die im Assistant konfigurierte Ebene.

UiPath verwendet die folgenden Protokollebenen, die in aufsteigender Reihenfolge ihrer Priorität aufgeführt sind.

• Aus – Es werden überhaupt keine Protokolle gespeichert. Diese Ebene wird normalerweise verwendet, um die Protokollierung zu deaktivieren.
• Verbose – Berichte mit einer noch feineren Granularität, die jedes mögliche Detail über die Automatisierungsvorgänge protokollieren. Dies können Informationen über Variablenänderungen, Funktionsaufrufe oder sogar externe Antworten sein. Zeigt alle Protokolle mit der Stufe Ablaufverfolgung an. Standardmäßig enthält die Stufe „Verbose“ die folgenden Protokolleinträge:
  • Ausführung gestartet – Wird jedes Mal erstellt, wenn ein Prozess gestartet wird.
  • Ausführung beendet – Wird jedes Mal erzeugt, wenn ein Prozess finalisiert wird.
  • Transaktion gestartet – Wird jedes Mal erzeugt, wenn der Roboter ein Transaktionselement vom Orchestrator erhält.
  • Transaktion beendet – Wird jedes Mal erzeugt, wenn der Roboter den Transaktionsstatus entweder auf Erfolgreich oder Fehlgeschlagen setzt.
  • Aktivitätsinformationen – Werden jedes Mal erzeugt, wenn eine Aktivität in einem Prozess gestartet, mit Fehler beendet oder beendet wurde.
• Ablaufverfolgung – Diese Protokolle enthalten die detailliertesten Informationen, die häufig zum Debuggen oder Nachverfolgen bestimmter Aufgabenausführungspfade innerhalb des Systems verwendet werden. Zeigt alle Protokolle mit den Stufen Ablaufverfolgung, Information, Warnung, Fehler und Kritisch an.
• Information – Informationsprotokolle bieten allgemeine Einblicke in die Automatisierungsausführung, z. B. Beginn und Ende von Aufgaben. Zeigt alle Protokolle mit den Stufen Information, Warnung, Fehler und Kritisch an.
• Warnung – Diese Protokolle enthalten kleinere Vorgänge oder mögliche Probleme, die sich nicht unmittelbar auf den aktuellen Betrieb auswirken, aber in Zukunft von Bedeutung sein könnten. Zeigt alle Protokolle mit den Stufen Warnung, Fehler und Kritisch an.
• Fehler – Protokolle, die auf dieser Ebene erstellt werden, enthalten Details zu Fehlern, die während der Ausführung aufgetreten sind und die den normalen Betrieb des Workflows verhindern, aber nicht das gesamte System zum Stillstand bringen. Zeigt alle Protokolle mit den Stufen Fehler und Kritisch an.
• Kritisch – Protokolle, die auf ein kritisches Problem oder einen Fehler hinweisen, werden aufgezeichnet. Probleme, die schwerwiegend genug sind, um sofortige Aufmerksamkeit zu erfordern, werden in der Regel auf dieser Ebene protokolliert.

Über PII-Informationen in Protokollen

Information, Warning, Error und Critical

Die Werte von Eingabe-/Ausgabeargumenten werden nicht nachverfolgt, wenn die Protokollebenen Information, Warning, Error und Critical verwendet werden. Das bedeutet, dass keine PII-Informationen in die Orchestrator Protokolle gesendet werden, es sei denn, sie wurden explizit aus Studio hinzugefügt.

Trace und Verbose

Die Protokollebenen Trace und Verbose verfolgen und schreiben die Werte von Eingabe-/Ausgabeargumenten in Orchestrator-Protokollen. Enthalten diese Werte PII-Informationen, dann werden sie den Orchestrator-Protokollen hinzugefügt.

Verwenden von excludeLoggedData zum Ausblenden vertraulicher Informationen

Mit der Variable excludedLoggedData können Sie Schlüsselwörter hinzufügen, um zu verhindern, dass Variablen- und Argumentwerte auf der Stufe Verbose protokolliert werden.

Dies kann auch erreicht werden, indem Sie das Private-Kontrollkästchen einer beliebigen Aktivität aktivieren. Hier erfahren Sie mehr über den Schutz sensibler Informationen.

"excludedLoggedData": [
      "Private:*",
      "<em>password</em>"
    ],

Protokolltypen

Abhängig vom Ereignis, das protokolliert wird, gibt es mehrere verschiedene Möglichkeiten, dass Protokollmeldungen vorkommen, und zwar:

Standard

Wird standardmäßig erzeugt, wenn die Ausführung eines Prozesses beginnt und endet, wenn ein Systemfehler auftritt und die Ausführung angehalten wird oder wenn die Protokollierungseinstellungen so konfiguriert sind, dass Ausführung jeder Aktivität protokolliert wird.

Hinweis: Diese Protokolle haben den Wert Default im Feld logType.

Die von dieser Kategorie protokollierten Ereignisse sind:

• Ausführungsstart wird jedes Mal erzeugt, wenn ein Prozess gestartet wird. Diese wird beginnend ab der Protokollierungsstufe Information protokolliert.
• Ausführungsende wird jedes Mal erzeugt, wenn ein Prozess beendet wird. Diese wird beginnend ab der Protokollierungsstufe Information protokolliert.
• Transaktionsstart wird jedes Mal erzeug, wenn eine Transaktion innerhalb eines Prozesses gestartet wird. Dies wird beginnend ab der Protokollierungsstufe Information protokolliert.
• Transaktionsende wird jede Mal erzeugt, wenn eine Transkation innerhalb eines Prozess abgeschlossen wird. Dieses wird beginnend ab der Protokollierungsstufe Information protokolliert.
• Fehlerprotokoll wird jedes Mal erzeugt, wenn die Ausführung auf einen Fehler trifft und angehalten wird. Dies wird beginnend ab der Protokollierungsstufe Fehler (Error) protokolliert.
• Debugging Log (Level = Trace) wird erzeugt, wenn „Robot Logging Setting“ auf „Verbose“ gesetzt ist, und enthält Aktivitätennamen, Typen, Variablennamen, Argumente usw. Dies wird beginnend ab der Protokollierungsstufe Rückverfolgung (Trace) protokolliert.

Benutzerdefiniert

Wird entsprechend dem vom Benutzer in Studio konzipierten Prozess erzeugt, wenn die Aktivität Protokollmeldung (Log Message) oder die Aktivität Zeile schreiben (Write Line) verwendet wird.

Hinweis: Diese Protokolle haben den Wert User im Feld logType.

Protokollfelder

Es gibt mehrere Typen an Protokollfeldern, die über alle oben genannten Protokollmeldungstypen zu finden sind. Diese können wie folgt klassifiziert werden:

Standardfelder

• Nachricht (Message) – Die Protokollmeldung
• Grad (Level) – Definiert den Protokoll-Schweregrad
• Zeitstempel - Datum und Uhrzeit, wann die Aktion durchgeführt wurde.
• FileName - Der Name der Datei .xaml, die ausgeführt wird.
• jobId * - Der Schlüssel des Auftrags, der den Prozess ausführt.
• processName * - Der Name des Prozesses, der die Protokollierung ausgelöst hat.
• processVersion * - Die Versionsnummer des Prozesses.
• windowsIdentity – Der Name des eingeloggten Benutzers, der die Aktion durchgeführt hat.
• robotName * - Der Name des Roboters (wie in Orchestrator definiert).
• machineName – Der Name der Robotermaschine.
• machineId * – Die ID der Robotermaschine.
• organizationUnitId * - Die ID der Orchestrator-Organisation.

* Mit einem Sternchen gekennzeichnete Protokollfelder können nicht mit der Aktivität Add Log Fields überschrieben werden.

Hinweis: Die Felder processName und processVersion erscheinen nicht in den Protokollen, wenn der Prozess lokal ohne Verbindung zu Orchestrator ausgeführt wird.

Typspezifische Felder

Diese Protokolle sind abhängig vom Protokolltyp vorhanden:

Ausführung beendet

• totalExecutionTimeInSeconds
• totalExecutionTime

Transaktionsstart

• Warteschlangenname (QueueName)
• transactionID
• transactionState
• initiatedBy

Transaktionsende

• Warteschlangenname (QueueName)
• transactionID
• transactionState
• transactionStatus
• Transaktionsausführungszeit
• Der Typ Verarbeitungsausnahme
• Grund für Verarbeitungsausnahme
• queueItemReviewStatus
• queueItemPriority

Debuggingprotokoll

activityInfo, was eine JSON-Meldung mit den folgenden Feldern ist:

• DisplayName
• Status (State) (Faulted, Closed, Executing)
• Aktivität

• Argumente

  Hinweis: totalExecutionTimeInSeconds, totalExecutionTime und queueName sind immer in den Protokollmeldungen vorhanden. Variables und Arguments haben üblicherweise Unterfelder.

Benutzerdefinierte Felder

Diese Felder werden in Studio mithilfe der Aktivität Add Log Fields erzeugt, und sie erscheinen in allen nachfolgenden Protokollen, nachdem die Aktivität erzeugt wurde, wenn sie nicht durch die Aktivität Remove Log Fields entfernt werden.

Wichtig:

Stellen Sie beim Definieren von benutzerdefinierten Protokollfeldern sicher, dass Sie auch die Benennung mit den Standardprotokollfeldern vergleichen, um widersprüchliche Informationen in den Protokolldateien über dieselben Protokollfelder zu vermeiden.

Die gleiche Namenskonvention für benutzerdefinierte und Standardprotokollfelder kann sich auch auf den von Ihnen ausgeführten Prozess auswirken.