Enregistrement des journaux du robot dans Elasticsearch

L'enregistrement des journaux du robot sur un serveur Elasticsearch peut être réalisé via deux types de configuration : de base et avancée.

La configuration de base fournit une fonctionnalité par défaut qui active la cible Elasticsearch NLog préconfigurée, qui est composée d'une cible Elasticsearch encapsulée dans une cible Buffering. Ce type de configuration est suffisant dans la plupart des scénarios.

Toutefois, si vous devez personnaliser davantage les règles, vous pouvez utiliser la méthode de configuration avancée.

Remarque : l’option permettant d’enregistrer les journaux du robot sur un serveur Elasticsearch ne devient efficace qu’une fois que vous l’avez configurée, et n’est pas appliquée rétroactivement. Cela signifie que vous n’aurez plus accès aux journaux qui se trouvaient déjà dans la base de données au moment où vous avez configuré l’option, car les journaux ne peuvent être récupérés et affichés qu’à partir d’une seule destination.

Configuration de base

1. Localisez l'application uipath dans l'interface ArgoCD .
2. Cliquez sur le bouton DÉTAILS DE L'APPLICATION ( APP DETAILS ) dans le coin supérieur gauche, puis accédez à l'onglet PARAMÈTRES .
3. Cliquez sur MODIFIER ( EDIT), puis mettez à jour les paramètres suivants avec les valeurs spécifiées dans la colonne de droite, en remplaçant les exemples par vos propres valeurs :

   Paramètre	Valeur (Value)
   global.userInputs.orchestratorRobotLogsElasticUri	Exemple : https://elastic.example.com:9200 Assurez-vous de ne pas inclure de barre oblique finale.
   global.userInputs.orchestratorRobotLogsElasticAuthUsername	Exemple : elastic-user
   global.userInputs.orchestratorRobotLogsElasticAuthPassword	Exemple : elastic-password

4. Enregistrez vos modifications.
5. Synchronisez l'application Uipath et attendez que la synchronisation se termine avec un retour d'état healthy.

Vous pouvez également configurer les journaux du robot à enregistrer sur un serveur Elasticsearch en modifiant le fichier cluster_config.json.

La configuration de base prend en charge Elasticsearch version 7.x. Pour Elasticsearch 8.x, vous devez utiliser la configuration avancée.

Configuration avancée

Important : toutes les modifications que vous apportez selon les étapes ci-dessous peuvent affecter négativement la fonctionnalité et la stabilité de l'ensemble du système. Il est conseillé de n’apporter des modifications que si vous en comprenez les conséquences.

La configuration avancée vous permet de personnaliser entièrement votre cible NLog.config .

1. Suivez les étapes de configuration de base décrites ci-dessus.
2. Modifiez les paramètres nlog.json dans orchestrator-customconfig dans ConfigMap.
   1. Créez un fichier /tmp/nlog.custom.json basé sur l'exemple ci-dessous.
   2. Utilisez ./orchestrator_configurator.sh -l /tmp/nlog.custom.json pour mettre à jour ConfigMap dans l' outil de configuration d'Orchestrator.

La configuration avancée prend également en charge Elasticsearch version 8.x.

Exemple pour Elasticsearch 7.x :

{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "logEvent",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}

Exemple pour Elasticsearch 8.x :

{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}