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^®

Protokollierungsstufe	Protokolliert	Beispiel/Kommentar	Protokolldatei	Ausgabebereich	Die Seite Orchestrator-Protokoll
Ausführlich	Aktivitäten	Ablaufverfolgung {"message":{"DisplayName":"Message box","State":"Executing","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX"}... Trace {"message":{"DisplayName":"Message box","State":"Closed","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}	Ja	Nein	Ja
Ausführlich	Variablen	"Variables":{"NewTransaction":"False"}}	Ja	Nein	Ja
Ausführlich	Argumente (Eigenschaften)	„Argumente“:{"Caption":"","Text":"String in Message BOX","ChosenButton":"Ok"}	Ja	Nein	Ja
Ablaufverfolgung	Aktivitäten	Trace {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}	Ja	Nein	Ja
Ablaufverfolgung	Zeile schreiben (WriteLine)	Ablaufverfolgung {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"} Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}	Ja	Ja	Ja
Informationen	Protokollmeldung	Info {"message":"message from activity" Hinweis: Außer Meldungen, die mit festgelegter Trace-Rückverfolgungsstufe in der Aktivität protokolliert werden.
Warnung	Warnungen	Warn {"message":"Warnung durch Protokollmeldungsaktivität"	Ja	Ja	Ja
Warnung	Fehler	Fehler {"message":"Fehler bei Aktivität der Protokollnachricht"	Ja	Ja	Ja
Warnung	Kritisch	Kritische Fehler	Ja	Ja	Ja
Fehler (Error)	Fehler	Fehler {"message":"Fehler bei Aktivität der Protokollnachricht"	Ja	Ja	Ja
Fehler (Error)	CriticalFatal	Kritische Fehler	Ja	Ja	Ja
Kritisch	CriticalFatal	Kritische Fehler	Ja	Ja	Ja
AUS (OFF)	n. a.	n. a.	Nein	Nein	Nein

Protokollierungsstufen in UiPath^®

Protokollierungsstufe	Standardprotokolle	Benutzerdefinierte Protokolle
Aus	Keine	Keine
Kritisch	Alle mit der Stufe Kritisch oder höher protokollierten Meldungen.	Alle mit der Stufe Kritisch oder höher protokollierten Meldungen.
Fehler (Error)	Alle mit der Stufe Fehler oder höher protokollierten Meldungen.	Alle mit der Stufe Fehler oder höher protokollierten Meldungen.
Warnung	Alle mit der Protokollierungsstufe Warnung oder höher protokollierten Meldungen.	Alle mit der Protokollierungsstufe Warnung oder höher protokollierten Meldungen.
Informationen	Alle Meldungen werden mit der Stufe Information oder einer höheren Stufe protokolliert.	Alle Meldungen werden mit der Stufe Information oder einer höheren Stufe protokolliert.
Ablaufverfolgung	Alle Meldungen werden mit der Stufe Trace oder einer höheren Stufe protokolliert.	Alle Meldungen werden mit der Stufe Trace oder einer höheren Stufe protokolliert.
Ausführlich	Alle Meldungen werden mit der Stufe Trace und in Workflow Tracking-Protokollen gespeichert.	Alle Meldungen werden mit der Stufe Trace protokolliert.

Auf der Stufe Verbose wird sowohl eine Meldung für den Start als auch für das Ende der Aktivität protokolliert, sowie die Werte der verwendeten Variablen und Argumente.

Standardmäßig umfasst die Stufe Verbose:

• Ausführung gestartet-Protokolleintrag – wird jedes Mal erzeugt, wenn ein Prozess gestartet wird.
• Ausführung beendet-Protokolleintrag – wird jedes Mal erzeugt, wenn ein Prozess finalisiert wird.
• Transaktion gestartet-Protokolleintrag – wird jedes Mal erzeugt, wenn der Roboter ein Transaktionsobjekt von Orchestrator erhält.
• Transaktion beendet-Protokolleintrag – wird jede Mal erzeugt, wenn der Roboter den Transaktionsstatus entweder auf Erfolgreich oder Fehlgeschlagen setzt.

• Aktivitätsinformationen-Protokolleintrag – wird jedes Mal erzeugt, wenn eine eine Aktivität in einem Prozessgestartet, mit Fehler beendet oder beendet wurde.

  Hinweis: Die Prioritätsreihenfolge der Protokolltypen ist: Ausführlich < Ablaufverfolgung < Information < Warnung < Fehler < Kritisch < Aus.

Ü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.