Enregistrement des journaux du robot dans Elasticsearch

Configurez Orchestrator pour enregistrer les journaux des évènements du Robot sur le serveur Elasticsearch dans Automation Suite.

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 du journal du robot Elasticsearch

Pour appliquer la configuration de base, procédez comme suit. Pour plus de détails, consultez la section Configuration des paramètres d'Orchestrator.

1. Dans le fichier de configuration, ajoutez une nouvelle section appelée orchestrator_robot_logs_elastic à la configuration d'Orchestrator, comme indiqué dans l'exemple suivant :

   "orchestrator": {
       "enabled": true,
       "orchestrator_robot_logs_elastic": {
           "elastic_uri": "https://elastic.example.com:9200",
           "elastic_auth_username": "elastic-user",
           "elastic_auth_password": "elastic-password"
       }
   }
   

2. Mettez à jour les paramètres suivants avec vos propres valeurs :

   Paramètre	Description
   elastic_uri	L'adresse de l'instance Elasticsearch devant être utilisée. Vous devez fournir l'adresse sous forme d'un URI, avec un nom d'utilisateur et un mot de passe. Exemple : https://elastic.example.com:9200 Assurez-vous de ne pas inclure de barre oblique.
   elastic_auth_username	Exemple : elastic-user
   elastic_auth_password	Exemple : elastic-password

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 du journal du robot Elasticsearch

Important :

Toutes les modifications que vous apportez lors des étapes suivantes peuvent avoir un impact négatif sur la fonctionnalité et la stabilité de l’ensemble du système. Il est conseillé de n'apporter des modifications que si vous comprenez leurs 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 précédemment.
2. Suivez les étapes de Configuration NLog avancée , puis mettez à jour la cible robotElasticBuffer avec les propriétés qui doivent être modifiées.

Remarque :

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

Exemple de nlog.config.json 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 de nlog.config.json 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"
        }
      }
    }
  }
}