Niveaux de journalisation

Pendant l’exécution du processus, le Robot génère un message (Journal) pour chaque étape tout au long du processus. Ceux-ci sont collectés et stockés dans un fichier journal. L’opération globale de collecte et de stockage des Journaux s’appelle la Journalisation.

Chaque Journal possède un niveau de journal qui se réfère à la façon dont le message généré est détaillé.

Les niveaux de journalisation renvoient au type de gravité écrit dans le fichier journal.

Niveaux de journalisation dans UiPath^®

Niveau de journal (Log Level)	Consigné (Logged)	Exemple/Commentaire	Fichier journal (Log File)	Volet Sortie (Output)	Page Journal d'Orchestrator (Orchestrator Log)
Détaillé (Verbose)	Activités (Activities)	Trace {"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":"Chaîne dans le message BOX","ChosenButton":"Ok"}	Oui (Yes)	Non (No)	Oui (Yes)
Détaillé (Verbose)	Variables	"Variables":{"NewTransaction":"False"}}	Oui (Yes)	Non (No)	Oui (Yes)
Détaillé (Verbose)	Propriétés (propriétés)	"Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}	Oui (Yes)	Non (No)	Oui (Yes)
Traçage (Trace)	Activités (Activities)	Traçage {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}	Oui (Yes)	Non (No)	Oui (Yes)
Traçage (Trace)	Écrire une ligne (WriteLine)	Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"} Traçage {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}	Oui (Yes)	Oui (Yes)	Oui (Yes)
Information	Consigner le message (Log Message)	Info {"message":"message from activity" Remarque: Sauf les messages enregistrés avec le niveau de Trace level défini dans l'activité.
Avertissement	Avertissements (Warnings)	Warn {"message":"Avertissement de l'activité des messages du journal"	Oui (Yes)	Oui (Yes)	Oui (Yes)
Avertissement	Erreurs (Errors)	Erreur {"message":"Erreur de l'activité des messages du journal"	Oui (Yes)	Oui (Yes)	Oui (Yes)
Avertissement	Critique (Critical)	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
Erreur	Erreurs (Errors)	Erreur {"message":"Erreur de l'activité des messages du journal"	Oui (Yes)	Oui (Yes)	Oui (Yes)
Erreur	CritiqueFatale	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
Critique (Critical)	CritiqueFatale	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
Désactivé (OFF)	s/o	s/o	Non (No)	Non (No)	Non (No)

Niveaux de journalisation dans UiPath^®

Niveau de journalisation	Journaux par défaut (Default Logs)	Journaux personnalisables (User-Defined Logs)
Désactivé (Off)	Aucun (None)	Aucun (None)
Critique (Critical)	Tous les messages consignés avec le niveau Critique (Critical) ou supérieur.	Tous les messages consignés avec le niveau Critique (Critical) ou supérieur.
Erreur	Tous les messages consignés avec le niveau Erreur (Error) ou supérieur.	Tous les messages consignés avec le niveau Erreur (Error) ou supérieur.
Avertissement	Tous les messages consignés avec le niveau Avertissement (Warning) ou supérieur.	Tous les messages consignés avec le niveau Avertissement (Warning) ou supérieur.
Information	Tous les messages consignés avec le niveau Informations ou supérieur.	Tous les messages consignés avec le niveau Informations ou supérieur.
Traçage (Trace)	Tous les messages consignés avec le niveau Traçage (Trace) ou supérieur.	Tous les messages consignés avec le niveau Traçage (Trace) ou supérieur.
Détaillé (Verbose)	Tous les messages consignés avec le niveau Traçage (Trace) et les journaux de traçage des flux de travail.	Tous les messages consignés avec le niveau Traçage (Trace).

Le niveau Détaillé (Verbose) consigne un message pour le début et la fin de l'activité, ainsi que les valeurs des variables et des arguments utilisés.

Par défaut, le niveau Détaillé (Verbose) inclut :

• Entrée de journal Exécution démarrée (Execution Started) : générée à chaque démarrage d'un processus.
• Entrée de journal Exécution terminée (Execution Ended) : générée à chaque finalisation d'un processus.
• Entrée de journal Transaction démarrée (Transaction Started) : générée chaque fois qu'un élément de transaction est récupéré par le Robot depuis Orchestrator.
• Entrée de journal Transaction terminée (Transaction Ended) : générée chaque fois que le Robot définit l'état de transaction sur Réussite (Success) ou sur Échec (Failed).

• Entrée de journal Informations de l'activité (Activity Information) : générée chaque fois qu'une activité est démarrée, défaillante ou terminée au sein d'un processus.

  Remarque : l'ordre de priorité des types de journaux est le suivant : Détaillé < Traçage < Information < Avertissement < Erreur < Critique < Off.

À propos des informations PII dans les journaux

Information, Warning, Error, et Critical

Les valeurs des arguments d'entrée/de sortie ne sont pas suivies lorsque les niveaux de journal Information, Warning, Error et Critical sont utilisés. Cela signifie qu'aucune information PII n'est envoyée dans les journaux Orchestrator, à moins qu'elle ne soit explicitement ajoutée à partir de Studio.

Trace et Verbose

Les niveaux de journal Trace et Verbose suivent et écrivent les valeurs des arguments d'entrée/de sortie dans les journaux Orchestrator. Si ces valeurs incluent des informations PII, elles sont ajoutées aux journaux Orchestrator.

Utiliser excludeLoggedData pour masquer les informations sensibles

La variable excludedLoggedData vous permet d'ajouter des mots-clés pour empêcher la journalisation des valeurs des variables et des arguments au niveau détaillé.

Vous pouvez également procéder en cochant la case Private de n'importe quelle activité. Apprenez-en davantage sur la protection des informations sensibles ici.

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

Types de journaux

Plusieurs occurrences de messages de journal sont possibles, en fonction de l'événement consigné, comme suit :

Default

Ils sont générés par défaut au début et à la fin de l'exécution d'un processus, lorsqu'une erreur système se produit et que l'exécution est interrompue, ou lorsque les paramètres de journalisation sont configurées pour consigner l'exécution de chaque activité.

Remarque : ces journaux indiquent la valeur Default dans le champ logType.

Les événements consignés par cette catégorie sont les suivants :

• L'évènement Début d'exécution (Execution Start) est généré à chaque démarrage d'un processus. Il est consigné à partir du niveau de journalisation Information.
• L'évènement Fin d'exécution (Execution End) est généré à chaque finalisation d'un processus. Il est consigné à partir du niveau de journalisation Information.
• L'évènement Début de transaction (Transaction Start) est généré à chaque démarrage d'une transaction au sein d'un processus. Il est consigné à partir du niveau de journalisation Information.
• L'évènement Fin de transaction (Transaction End) est généré à chaque finalisation d'une transaction au sein d'un processus. Il est consigné à partir du niveau de journalisation Information.
• L'évènement Journal des erreurs (Error Log) est généré chaque fois que l'exécution rencontre une erreur et qu'elle s'arrête. Il est consigné à partir du niveau de journalisation Erreur (Error).
• Journal de débogage (Debugging Log) : les journaux sont enregistrés si la journalisation du Robot est configurée avec le niveau Détaillé (Verbose). Il contient les noms et les types des activités, les valeurs des variables, les arguments, etc. Il est consigné à partir du niveau de journalisation Traçage (Trace).

Défini par l'utilisateur

Générés selon le processus conçu par l'utilisateur dans Studio, lorsque l'activité Message du journal des événements (Log Message) ou l'activité Écrire une ligne (Write Line) est utilisée.

Remarque : ces journaux indiquent la valeur User dans le champ logType.

Champs d'un journal (Log Fields)

Plusieurs types de champs de journal sont disponibles dans tous les types de messages de journaux ci-dessus. Ils peuvent être classés comme suit :

Champs par défaut

• Message (Message) - le message du journal des événements
• Niveau (Level) - définit la gravité du journal.
• Timestamp - la date et l'heure exactes de l'événement.
• Nom de fichier (FileName) - le nom du fichier .xaml en cours d'exécution.
• IdTâche (jobId)  * : la clé de la tâche qui exécute le processus.
• NomProcessus (processName)  * : le nom du processus qui déclenche la journalisation
• VersionProcessus (processVersion)  * : le numéro de version du processus.
• windowsIdentity - le nom de l'utilisateur qui a déclenché l'événement qui a été enregistré.
• NomRobot (robotName)  * : le nom du robot (défini dans Orchestrator)
• machineName : le nom de la machine robot.
• IdMachine (machineId) * : l'ID de la machine robot.
• IdUnitéOrganisation (OrganizationUnitId) * : l’ID de l’organisation Orchestrator.

* Les champs de journal marqués d'un astérisque ne peuvent pas être remplacés à l'aide de l'activité Ajouter des champs de journal (Add Log Fields).

Remarque : les champs processName et processVersion ne s'affichent pas dans les journaux si le processus est exécuté localement, sans être connecté à Orchestrator.

Champs spécifiques au type

La présence de ces journaux varie en fonction du type de journal.

Fin d'exécution (Execution End)

• totalExecutionTimeInSeconds
• totalExecutionTime

Début de transaction (Transaction Start)

• QueueName
• transactionID
• transactionState
• InitiéPar (initiatedBy)

Fin de transaction (Transaction End)

• QueueName
• transactionID
• transactionState
• transactionStatus
• Délai d'exécution de la transaction (Transaction Execution Time)
• Type d'exception de traitement (ProcessingException Type)
• processingExceptionReason
• queueItemReviewStatus
• queueItemPriority

Journal de débogage (Debugging Log)

activityInfo, un message JSON composé des champs suivants :

• DisplayName
• État (State) - Défaillant (Faulted), Fermé (Closed), En cours d'exécution (Executing)
• Activité

• Arguments

  Remarque : seuls totalExecutionTimeInSeconds, totalExecutionTime et queueName sont toujours présents dans les messages du journal. Variables et Arguments ont généralement des sous-champs.

Champs définis par l'utilisateur

Ces champs sont définis dans Studio à l'aide de l'activité Ajouter des champs de journaux (Add Log Fields) et s'affichent dans tous les journaux suivants après la génération de l'activité, sauf s'ils sont supprimés par l'activité Supprimer les champs de journaux (Remove Log Fields).

Important :

Lors de la définition des champs de journal personnalisés, assurez-vous également de vérifier le nom par rapport aux champs de journal par défaut pour éviter les informations en conflit dans les fichiers journaux avec les mêmes champs de journal.

Avoir la même convention de nommage pour les champs de journal personnalisés et par défaut peut également avoir un impact sur le processus que vous exécutez.