Salvando logs do robô no Elasticsearch

Salvar logs do robô em um servidor Elasticsearch pode ser feito por meio de dois tipos de configuração: básico e avançado.

A configuração básica fornece a funcionalidade padrão que ativa o destino do Elasticsearch NLog pré-configurado, que é composto de um destino do Elasticsearch encapsulado em um destino de buffer. Esse tipo de configuração é suficiente na maioria dos cenários.

No entanto, se você precisar personalizar ainda mais as regras, poderá usar o método de configuração avançada.

Observação:

A opção de salvar logs do robô em um servidor do Elasticsearch só se torna efetiva depois que você o configura, e não é aplicada retroativamente. Isso significa que você não terá mais acesso a quaisquer logs que já estavam no banco de dados no momento em que você configurou a opção, porque os logs só podem ser recuperados e exibidos a partir de um único destino.

Configuração básica

1. Locate the uipath application in the ArgoCD interface.

2. Clique no botão DETALHES DO APP no canto superior esquerdo e navegue até a guia PARÂMETROS.

3. Clique em EDITAR e atualize os seguintes parâmetros com os valores especificados na coluna da direita, substituindo os exemplos pelos seus próprios valores:

   Parâmetro	Valor
   global.userInputs.orchestratorRobotLogsElasticUri	Exemplo: https://elastic.example.com:9200 Certifique-se de não incluir uma barra final.
   global.userInputs.orchestratorRobotLogsElasticAuthUsername	Exemplo: elastic-user
   global.userInputs.orchestratorRobotLogsElasticAuthPassword	Exemplo: elastic-password

4. Salve suas alterações.

5. Sincronize o aplicativo uipath e aguarde o processo terminar com uma resposta de estado healthy.

You can also configure robot logs to be saved to an Elasticsearch server by editing the cluster_config.json file.

A configuração básica oferece suporte ao Elasticsearch versão 7.x. Para Elasticsearch 8.x, você precisa usar a configuração avançada.

Configuração avançada

Importante:

Quaisquer alterações feitas de acordo com as etapas abaixo podem afetar negativamente a funcionalidade e a estabilidade de todo o sistema. É aconselhável fazer alterações apenas se você entender suas consequências.

A configuração avançada permite que você personalize totalmente seu destino NLog.config.

1. Follow the basic configuration steps described above.
2. Edite os parâmetros nlog.json em orchestrator-customconfig no ConfigMap.
   1. Crie um arquivo /tmp/nlog.custom.json com base na amostra abaixo.
   2. Use ./orchestrator_configurator.sh -l /tmp/nlog.custom.json to update ConfigMap in the Orchestrator Configurator Tool.

Observação:

A configuração avançada também oferece suporte ao Elasticsearch versão 8.x.

Amostra para 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"
        }
      }
    }
  }
}

Amostra para 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"
        }
      }
    }
  }
}