Journal des évènements du Robot

Les journaux sont des fichiers portant la date et l'heure de leur création et contenant un historique des événements, des messages d'erreur et des avertissements relatifs à l'application.

Les types de journaux sont présentés dans les pages suivantes :

Journaux d'exécution du Robot

Les journaux d'exécution du Robot sont des messages générés par l'exécution d'un processus. Ils contiennent des informations relatives à son comportement et des messages définis par l'utilisateur dans le workflow.

Les journaux d'exécution sont générés par :

• L'activité Ligne d'écriture (Write Line) qui sert à créer des journaux au niveau du Traçage.
• L'activité Message du journal des événements (Log Message) qui génère des journaux au niveau indiqué dans le champ de propriété du Niveau (Level) de l'activité.
• L'exécution d'un projet d'automatisation, qui génère des journaux contenant le comportement de chaque activité. Ces journaux utilisent le niveau Trace si le paramètre Niveau (Niveau) dans la fenêtre Paramètres d'Orchestrator (Orchestrator Settings) de l'Assistant est défini sur Détaillé (Verbose).

Niveau de journalisation des journaux d'exécution

Le niveau de journalisation par défaut est contrôlé par le paramètre Niveau (Level) stocké dans la fenêtre Paramètres d'Orchestrator (Orchestrator Settings). Par défaut, il est défini sur Information.

Remarque : le niveau de journal défini dans Orchestrator pour le robot remplace celui défini dans UiPath^® Assistant.

Seuls les journaux qui correspondent au niveau spécifié dans les paramètres de l’Assistant ou d’Orchestrator sont envoyés à Orchestrator.

Modification du niveau de journalisation par défaut depuis l'Assistant :

1. Depuis UiPath^® Assistant, accédez au menu Préférences, puis aux paramètres d’Orchestrator

2. Sélectionnez le niveau de journalisation de votre choix dans le menu déroulant Niveau, dans la section Journalisation.

   Remarque : si le Robot est installé en tant que service Windows, vous devez disposer de droits administrateur pour modifier ce paramètre.

Cible Orchestrator

Si le Robot est connecté à Orchestrator, seuls les journaux correspondant au niveau défini dans l’Assistant ou Orchestrator s’affichent sur la page Journaux (Logs).

Si Orchestrator n'est pas disponible, les journaux sont enregistrés dans une base de données locale (C:\Windows\System32\config\systemprofile\AppData\Local\UiPath\Logs\execution_log_data), dans l'espace disque disponible, jusqu'au rétablissement de la connexion. Ensuite, les journaux sont envoyés par lots, dans l'ordre de leur création.

Remarque : la base de données n'est pas supprimée une fois les journaux envoyés à Orchestrator.

Cible NLog

De plus, les cibles et le contenu des logs peuvent être configurés en modifiant le fichier <Installation Folder>\NLog.config.

L'emplacement cible des journaux est contrôlé par le fichier <Installation Folder>\NLog.config. Les journaux de diagnostic sont collectés par l'enregistreur de type interne et sont transmis à l'aide de cibles NLog.

Par défaut, les journaux d'exécution sont stockés dans un fichier dans le dossier %LocalAppData%\UiPath\Logs. Les messages sont collectés par l'enregistreur WorkflowLogging et peuvent être transférés à l'aide de cibles NLog, comme spécifié par les paramètres suivants dans le fichier NLog.config :

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
  <rules>
    <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
  </rules>
  <targets>
    <target type="File" name="WorkflowLogFiles" fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log" layout="${time} ${level} ${message}" keepFileOpen="true" openFileCacheTimeout="5" concurrentWrites="true" encoding="utf-8" writeBom="true" />
  </targets>
</nlog>

Suppression des anciens fichiers journaux de workflow

Pour éviter de créer une grande quantité de fichiers journaux qui consomment de l'espace disque sur la machine, vous pouvez choisir d'archiver les fichiers journaux une fois qu'un nombre spécifique de fichiers a été atteint.

Cela se fait en ajoutant les paramètres suivants dans la balise <target> NLog.config :

• archiveNumbering="Date"
• archiveEvery="Day"
• archiveDateFormat="yyyy-MM-dd"
• archiveFileName="${WorkflowLoggingDirectory}/{#}_Execution.log"

• maxArchiveFiles="10"

  <?xml version="1.0" encoding="utf-8" ?>
  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
    <rules>
      <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
    </rules>
    <targets>
      <target type="File"
        name="WorkflowLogFiles"
        fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log"
        layout="${time} ${level} ${message}"
        keepFileOpen="true"
        openFileCacheTimeout="5"
        concurrentWrites="true"
        encoding="utf-8"
        writeBom="true"
        archiveNumbering="Date"
        archiveEvery="Day"
        archiveDateFormat="yyyy-MM-dd"
        archiveFileName="${WorkflowLoggingDirectory}/{#}_Execution.log"
        maxArchiveFiles="10"
      />
    </targets>
  </nlog>

  Remarque : maxArchiveFiles est le paramètre contrôlant le nombre de fichiers d'archive.
  Remarque : des privilèges administrateur sont requis pour modifier le fichier NLog.config. Il est inutile de redémarrer le Robot pour que les modifications prennent effet.

Modification supplémentaire des journaux

Si le niveau de journalisation choisi est Détaillé (Verbose), les messages contiennent le déroulement entier de l'exécution des activités. Cette sortie de journal peut être personnalisée en modifiant le fichier UiPath.Executor.exe.config, depuis le dossier C:\Program Files\UiPath\Studio.

Pour cela, le code XML suivant doit être ajouté sous la balise <system.serviceModel>.

<tracking>
    <profiles>
        <trackingProfile name="StandardProfile">
         <workflow>
          <activityStateQueries>  
            <activityStateQuery activityName="*">
                <states>  
                    <state name="Faulted"/>  
                </states>
                <arguments>  
                    <argument name="*"/>  
                </arguments> 
                 <variables>  
                    <variable name="*"/>  
                </variables>             
            </activityStateQuery>
          </activityStateQueries>    
         </workflow>
        </trackingProfile>       
    </profiles>
</tracking>

Étant donné que la balise <states> ne contient que <state name="Faulted"/> , l'insertion du code ci-dessus permet de consigner uniquement les activités ayant l'état Faulted. L'ajout d'autres paramètres sous la balise <states>, tels que <state name="Executing"/>, entraîne également la journalisation des activités qui ont d'autres états.

Non seulement les états d'activité peuvent être modifiés, mais les variables et les arguments également. Vous trouverez plus d'informations sur la personnalisation ici.

Remarque : pour que les modifications apportées au fichier UiPath.Executor.exe.config prennent effet, il est nécessaire de redémarrer le service du Robot.

Journaux de diagnostic du Robot

Les journaux de diagnostic du robot fournissent des informations relatives au robot lui-même et à son contexte. Ils sont utiles pour identifier la cause d'une erreur spécifique.

Les journaux de diagnostic du Robot sont enregistrés aux emplacements suivants :

• Sous Windows, les journaux des diagnostics relatifs aux erreurs sont consignés dans l'Observateur d'événements.

• Les journaux de diagnostic détaillés sont écrits dans un fichier pour toutes les plates-formes, y compris Windows :

  • %LocalAppData%\UiPath\Logs\internal\Robot.log sous Windows lorsque le robot est installé en mode utilisateur.
  • %PROGRAMDATA%\UiPath\Logs\internal\Robot.log sous Windows lorsque le robot est installé en mode service.
  • ~/.local/share/UiPath/Logs/internal/Robot.log sur d'autres plates-formes.

Journaux de diagnostic du pilote

Traçage de pilote (Driver Tracing) est écrit dans un fichier .etl.

Pour activer le traçage de pilote (To enable Driver Tracing), ouvrez l'Invite de commandes (Command Prompt) avec des droits d'administrateur, accédez au répertoire d'installation à l'aide de l'argument cd, tel que cd C:\Program Files\UiPath\Studio, et exécutez la commande UiRobot.exe --enableLowLevel.

Pour désactiver le traçage de pilote (To disable Driver Tracing), ouvrez l'Invite de commandes (Command Prompt) avec des droits d'administrateur, accédez au répertoire d'installation à l'aide de l'argument cd, tel que cd C:\Program Files\UiPath\Studio, et exécutez la commande UiRobot.exe --disableLowLevel.

Remarque :

Nous vous recommandons d’activer le suivi à faible niveau uniquement lors de l’enquête sur un problème et de le désactiver lorsque la session d’enquête est terminée.

En outre, le fichier .etl contenant les informations de traçage est généré uniquement une fois la fonctionnalité désactivée.

Il est inutile de redémarrer le Robot pour que les modifications prennent effet.