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

Le niveau de journalisation fait référence à la façon dont le message généré doit être détaillé. Vous pouvez le configurer via :

• le paramètre Niveau de journalisation dans Assistant > Préférences > page Général. Par défaut, il est défini sur Information.
• le paramètre Niveau de journalisation dans Orchestrator > Gérer l’accès > Utilisateurs > compte utilisateur ou Robot > page Paramètres du Robot. Par défaut, il est défini sur Information.
  Remarque :

  Le niveau de journalisation que vous avez défini dans Orchestrator remplace le niveau configuré dans UiPath Assistant.

UiPath utilise les niveaux de journalisation suivants, répertoriés par ordre croissant de priorité.

• Désactivé : aucun journal n’est stocké. Ce niveau est généralement utilisé pour désactiver la journalisation.
• Détaillé : indique un niveau de précision accru, qui journalise tous les détails possibles sur les opérations d’automatisation. Sont inclus les informations sur les modifications de variables, les appels de fonction, voire les réponses externes. Affiche tous les journaux avec le niveau Traçage. Par défaut, le niveau Détaillé inclut les entrées de journal suivantes :
  • Exécution démarrée : généré à chaque démarrage d’un processus.
  • Exécution terminée : généré à chaque finalisation d’un processus.
  • Transaction démarrée : généré chaque fois qu’un élément de transaction est récupéré par le Robot depuis Orchestrator.
  • Transaction terminée : généré chaque fois que le Robot définit le statut de transaction sur Réussite ou Échec.
  • Informations de l’activité : générées chaque fois qu’une activité est démarrée, défaillante ou terminée au sein d’un processus.
• Traçage : ces journaux contiennent les informations les plus détaillées, souvent utilisées pour le débogage ou le suivi de chemins d’exécution de tâches spécifiques au sein du système. Affiche tous les journaux avec les niveaux Traçage, Information, Avertissement, Erreur et Critique.
• Information : les journaux d’informations fournissent des informations générales sur l’exécution de l’automatisation, telles que le début et la fin des tâches. Affiche tous les journaux avec les niveaux Information, Avertissement, Erreur et Critique.
• Avertissement : ces journaux contiennent des problèmes mineurs ou des problèmes potentiels qui n’affectent pas immédiatement le fonctionnement en cours, mais qui peuvent devenir importants à l’avenir. Affiche tous les journaux avec les niveaux Avertissement, Erreur et Critique.
• Erreur : les journaux générés à ce niveau incluent les détails des erreurs qui se sont produites pendant l’exécution, qui empêchent le fonctionnement normal du workflow mais n’entraînent pas l’arrêt de tout le système. Affiche tous les journaux de niveau Erreur et Critique.
• Critique : les journaux indiquant un problème ou une erreur critique sont enregistrés. Les problèmes suffisamment graves pour nécessiter une attention immédiate sont généralement consignés à ce niveau.

À propos des informations PII dans les journaux

Information, WarningError, 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.

Utilisation excludeLoggedData pour masquer des 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é.

Cela peut également être réalisé en cochant la Privatecase de n'importe quelle activité. En savoir plus 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 - The log message.
• Level - Defines the log severity.
• Timestamp - The exact date and time the action was performed.
• FileName - The name of the .xaml file being executed.
• 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 - The name of the user that performed the action that was logged.
• NomRobot (robotName)  * : le nom du robot (défini dans Orchestrator)
• machineName - The name of the robot machine.
• 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 disposent généralement de 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.