Salvando logs do robô no Elasticsearch

Defina as configurações básicas e avançadas para salvar logs do robô em um servidor do Elasticsearch no Automation Suite.

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 do Elasticsearch de log do robô

Para aplicar a configuração básica, siga as seguintes etapas. Para obter detalhes, consulte Configuração dos parâmetros do Orchestrator.

1. No arquivo de configuração, adicione uma nova seção chamada orchestrator_robot_logs_elastic à configuração do Orchestrator, conforme mostrado no exemplo a seguir:

   "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. Atualize os parâmetros a seguir com seus próprios valores:

   Parâmetro	Description
   elastic_uri	O endereço da instância do Elasticsearch que deve ser usado. Você deve fornecer o endereço como um URI, juntamente com um nome de usuário e senha. Exemplo: https://elastic.example.com:9200 Certifique-se de não incluir uma barra final.
   elastic_auth_username	Exemplo: elastic-user
   elastic_auth_password	Exemplo: elastic-password

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 do Elasticsearch de log do robô

Importante:

Quaisquer alterações feitas de acordo com as próximas etapas 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. Siga as etapas de configuração básica descritas anteriormente.
2. Siga as etapas de configuração avançada do NLog e atualize o destino robotElasticBuffer com as propriedades que precisam ser alteradas.

Observação:

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

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