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 avertissement relatifs à l'application.

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.

L'état d'une tâche est enregistré dans la mémoire du service UiPath Robot. Lorsqu'Orchestrator est à disponible, les informations relatives à l'état de la tâche sont synchronisées entre les deux. Toutefois, si Orchestrator n'est pas disponible et que vous redémarrez le service UiPath Robot, les informations sont perdues. Cela signifie qu'à chaque fois qu'Orchestrator est disponible, la tâche est réexécutée.

Journaux de diagnostic du Robot

Ces journaux contiennent des informations liées au Robot (Robot) et à son environnement direct. Ils sont utiles pour identifier la cause d'une erreur spécifique.

Activer les journaux de diagnostic du Robot

Par défaut, les journaux diagnostic du Robot sont activés et tous les messages de type Erreur (Error) ou Avertissement (Warning) sont enregistrés.

Si vous avez besoin d'enregistrer d'autres types d'évènements, vous pouvez également les activer, à condition que l'option de Traçage faible soit activée. Par défaut, cette option est désactivée.

Pour activer le traçage à faible niveau, exécutez la commande suivante UiRobot.exe --enableLowLevel dans l’invite de commande.

Pour désactiver le traçage à faible niveau, exécutez la commande suivante UiRobot.exe --disableLowLevel dans l’invite de commande.

L'activation du traçage de bas niveau en tant qu'administrateur, utilisateur local ou de domaine démarre le traçage de bas niveau pour le fichier .etl. Cela active le traçage détaillé pour l'exécuteur et le service Robot dans l'Observateur d'événements.

Souvenez-vous de commencer par vous rendre dans le répertoire d'installation, en utilisant l'argument cd. Par exemple : cd C:\Program Files\UiPath\Studio.

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.

Cibles des journaux de diagnostic du Robot

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 internes sont envoyés à l'Observateur d'événements, comme indiqué dans les lignes provenant de NLog.config ci-dessous :

<target xsi:type="EventLog" name="eventLog" layout="${callsite:className=false:includeSourcePath=true:methodName=false} ${message}" source="UiPath" log="Application" />

<logger name="Internal" minLevel="Trace" writeTo="eventLog" />

Remarque : des privilèges administrateur sont requis pour modifier le fichier NLog.config. Le service UiRobot.exe doit être redémarré si la cible Interne (Internal) est modifiée dans le fichier NLog.config pour que les modifications prennent effet.

Consulter le fichier journal .etl

Ce type de fichier peut être ouvert à partir de l'Observateur d'événements.

1. Dans le volet Actions de l'Observateur d'événements, cliquez sur Ouvrir le journal enregistré (Open Saved Log). La fenêtre Ouvrir le journal enregistré (Open Saved Log) s'affiche.
2. Chercher le fichier journal généré par l'option de traçage et cliquer sur Ouvrir pour qu'il apparaisse dans le panneau de gauche, sous Journaux enregistrés (Saved Logs).

3. Sélectionnez le fichier. Notez que le contenu des journaux s'affiche.

   
   

   

   
   

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. En règle générale, ils contiennent des informations liées au déroulement de celui-ci, ainsi que des messages définis par l'utilisateur.

Les journaux d'exécution peuvent être créés de plusieurs façons :

• L'activité Écrire une ligne (Write Line) génère des journaux au niveau du Traçage.
• L'activité Message du journal des événements (Log Message) génère des journaux appartenant au niveau indiqué dans le champ des propriétés du Niveau (Level).
• L'exécution d'un projet d'automatisation génère des journaux qui contiennent le comportement de chaque activité. Ces journaux ont le niveau de traçage si le paramètre Niveau (Level) dans la fenêtre Paramètres d'Orchestrator (Orchestrator Settings) est défini sur 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.

Modification du Niveau de Journalisation par défaut dans la fenêtre Paramètres d'Orchestrator (Orchestrator Settings) :

1. Depuis l'assistant UiPath, 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.

Cibles des journaux d'exécution

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>

Si le Robot est connecté à Orchestrator, tous les logs d'exécution sont envoyés à Orchestrator et peuvent être consultés sur la page Logs.

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

Suppression des anciens fichiers journaux

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.

Pour cela, ajoutez les paramètres suivants dans la balise <target> :

• 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 ce faire, le code XML doit être ajouté sous la balise <system.serviceModel>. Par exemple :

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