Configurer les règles de journalisation

Configurer les règles de journalisation du robot pour l'ingestion par Insights dans Automation Suite sur OpenShift.

Vue d'ensemble (Overview)

Les journaux des événements du Robot capturent les journaux de diagnostic et d'exécution. Vous pouvez configurer les conditions selon lesquelles les journaux des événements du Robot sont ingérés par Insights. Par exemple, vous souhaitez uniquement capturer les journaux des processus qui incluent un nom spécifique.

Pour de plus amples informations, consultez la section Journaux du Robot.

Quand configurer les règles de journalisation

• Après l'installation d'Insights.
• Après la mise à niveau d'Insights.
• Lorsque vous souhaitez ajouter ou configurer des règles de journalisation existantes.

Règles de journalisation par défaut

Les paramètres par défaut des journaux des événements du Robot ingérés par Insights incluent Ingérer uniquement les derniers journaux et les journaux de niveau Erreur (Ingest only last logs and error logs). Les sections suivantes présentent les règles de journalisation par défaut en fonction de la version d'Insights que vous exécutez.

Règles de journalisation par défaut pour les versions 2022.4 et supérieures

Dans cet exemple, les derniers journaux et les journaux de niveau Erreur (Error) de tous les processus sont ingérés. Cette version d'Insights ingère le dernier niveau Info d'un Robot qui a exécuté un processus, ainsi que les journaux de processus et de niveau Erreur (Error), comme illustré dans l'exemple suivant.

<logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="true" minlevel="Info" writeTo="insightsRobotLogs">
        <filters defaultAction="Ignore">
          <when condition="level &gt;= LogLevel.Error or ends-with('${message}',' execution ended')" action="Log" />
          <when condition="'${ui-robot-logs-num-custom-fields}' &gt; 1 and not ends-with('${message}', ' execution started')" action="Log" />
        </filters>

Règles de journalisation par défaut pour la version 2021.10

Dans cet exemple, tous les journaux (niveau Info et supérieur) de tous les processus sont ingérés. Cette version d'Insights ingère tous les journaux (niveau Info et supérieur) générés par le Robot pour tous les processus, comme illustré dans l'exemple suivant.

<logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="true" minlevel="Info" writeTo="insightsRobotLogs"/>

Configurer les règles de journalisation

Remarque :

• Seuls les Administrators doivent modifier les valeurs dans le fichier de configuration d'Orchestrator.
• Sauvegardez le fichier UiPath.Orchestrator.dll.config avant de continuer. Vous pouvez trouver ce fichier dans C:\Program Files (x86)\UiPath\Orchestrator.
• Redémarrez le site Web après avoir apporté des modifications au fichier de configuration d'Orchestrator.
• Tous les paramètres sont sensibles à la casse.
• Pour de meilleures performances, les journaux des événements du Robot générés sur une période de deux ans ne doivent pas dépasser 200 millions d'enregistrements.
• Utilisez le fichier de configuration NLog pour capturer les données pertinentes pour Insights dans votre environnement et réduire le nombre d'enregistrements générés par les journaux des événements du Robot.

1. Accédez à C:\Program Files (x86)\UiPath\Orchestrator et ouvrez le fichier UiPath.Orchestrator.dll.config pour modifier les paramètres d'Orchestrator.
2. Recherchez les paramètres Journaux des événements du Robot (Robot Logs) (par exemple, <logger name="Robot.*" environmentSpecificConfiguration/>).
3. Configurez un filtre avec une action par défaut (par exemple, filters defaultAction="Ignore").
4. Configurez les conditions en fonction du niveau de journalisation ou d’autres événements (consultez la section Exemple de règles de journalisation).
5. Enregistrez le fichier et redémarrez Orchestrator.

Pour de plus amples informations sur la configuration du fichier de configuration d'Orchestrator, consultez le fichier UiPath.Orchestrator.dll.config.

Exemples de règles de journalisation

Les exemples suivants montrent des configurations de règles de journalisation personnalisées pour les journaux de niveau Info et Erreur (Error). En définissant des conditions spécifiques, Insights ingère les journaux uniquement pour les processus que vous configurez.

{
  "10_Robot_Insights": {
    "enabled": false,
    "final": false,
    "logger": "Robot.*",
    "minLevel": "Info",
    "ruleName": "insightsRobotLogsRule",
    "writeTo": "insightsRobotLogs"
  }
}

Ingérer tous les journaux et tous les journaux de niveau Erreur (Error) pour un processus particulier

Dans l'exemple suivant, Insights ingère tous les journaux de niveau Info et Erreur (Error) pour les noms de processus suivants : payment disp, 68fields ou 68fields_20.

<logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="true" minlevel="Info" writeTo="insightsRobotLogs">
    <filters defaultAction="Ignore">
      <when condition="equals('${event-properties:item=processName}', 'payment disp') or equals('${event-properties:item=processName}', '68fields') or equals('${event-properties:item=processName}', '68fields_20')" action="Log" />
    </filters>
  </logger>

Ingérer uniquement les derniers journaux et les journaux de niveau Erreur (Error) pour un processus particulier

Dans l'exemple suivant, Insights ingère uniquement les derniers journaux du niveau Info et les journaux de niveau Erreur (Error) pour les noms de processus suivants : payment disp, 68fields ou 68fields_20.

Seuls les journaux de niveau Erreur et le dernier journal de chaque Robot sont connectés à Insights.

<logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="true" minlevel="Info" writeTo="insightsRobotLogs">
    <filters defaultAction="Ignore">
      <when condition="(level >= LogLevel.Error or ends-with('${message}',' execution ended')) and (contains('${event-properties:item=processName}', 'payment disp') or equals('${event-properties:item=processName}', '68fields') or equals('${event-properties:item=processName}', '68fields_20'))" action="Log" />
    </filters>
  </logger>

Ne pas ingérer les journaux d'un processus particulier

Dans l'exemple suivant, Insights n'ingère aucun journal pour le nom de processus : payment disp.

<logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="true" minlevel="Info" writeTo="insightsRobotLogs">
    <filters defaultAction="Log">
      <when condition="equals('${event-properties:item=processName}', 'payment disp')" action="Ignore" />
    </filters>
  </logger>

Articles associés

Fichier de configuration NLog