Niveaux de journalisation

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 flux de travail.

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

  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"}...	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)	`Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity	Oui (Yes)	Non (No)	Oui (Yes)
  Information	Écrire une ligne (WriteLine) 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é.	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Avertissement	Avertissements (Warnings)	Warn {"message":"Warning from log message activity"	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Avertissement	Erreurs (Errors)	Error {"message":"Error from log message activity"	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Avertissement	Critique (Critical)	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Erreur	Erreurs (Errors)	Error {"message":"Error from log message activity"	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Erreur	Critique (Critical) Critique	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Critique (Critical)	Critique (Critical) Critique	Erreurs critiques	Oui (Yes)	Oui (Yes)	Oui (Yes)
  Désactivé (OFF)	s/o	s/o	Non (No)	Non (No)	Non (No)

Types de messages de journaux

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

Journaux par défaut (Default Logs)

Ils sont générés par défaut au début et à la fin de l'exécution d'un projet, 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).
• L'évènement Journal de débogage (Debugging Log) est généré si l'option Paramètre de journalisation du robot (Robot Logging Setting) est configurée sur Détaillé (Verbose) et qu'il contient les noms des activités, les types, les valeurs des variables, les arguments, etc. Il est consigné à partir du niveau de journalisation Traçage (Trace).

Journaux personnalisables (User-Defined Logs)

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

Ces champs de journal sont présents dans tous les types de journaux d'exécution, comme par exemple SQL (si configuré), Elasticsearch (si configuré) et les journaux de l'observateur d'évènements par défaut :

• Message : message du journal.
• Level : définit le niveau de gravité de l'événement.
• Timestamp : la date et l'heure exactes de réalisation de l'action.
• FileName : le nom du fichier .xaml en cours d'exécution.
• jobId : la clé de la tâche qui exécute le processus.
• processName : le nom du processus qui a déclenché la journalisation.
• processVersion : le numéro de version du processus.
• windowsIdentity : le nom de l'utilisateur qui a effectué l'action consignée.
• robotName : le nom du Robot (tel qu'il est défini dans Orchestrator).

Dans un environnement avec plusieurs Robots sur une machine, qui sont connectés à Orchestrator, il est possible que les journaux de l'Observateur d'événements affichent le message suivant : “L'utilisateur actuel ne s'est pas connecté à l'application!". Ceci se produit si vous supprimez un Robot pour lequel il restait des journaux à envoyer à Orchestrator.

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

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
  • State (Défaillant (Faulted), Fermé (Closed), En cours d'exécution (Executing))
  • Activité
  • Variables

  • 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).

Remarque :

La création de champs de journaux personnalisés qui ont le même nom qu’un champ de journal par défaut provoque la corruption du processus de journalisation et peut causer des problèmes dans le workflow en cours d’exécution.

Par exemple, ce problème peut être causé par la création d'un champ de journal personnalisé nommé jobId, car jobId est un champ de journal généré par défaut.