Observabilidade de agente privado com Elasticsearch

Introdução

Esta página mostra como você pode monitorar remotamente o desempenho e o comportamento de agentes privados Docker, Linux ou Windows usando a plataforma de observabilidade Elasticsearch e Kibana. Quando configurados, as métricas dos seus agentes privados podem ser visualizadas usando o painel pré-construído fornecido pela Jitterbit, ou seu próprio painel personalizado.

Para configurar o Elasticsearch e o Kibana, siga as etapas nestas seções na ordem:

1. Atenda aos pré-requisitos.

2. Instale os agentes Metricbeat e Filebeat no host do agente privado.

3. Defina a política de ciclo de vida do Kibana.

4. Crie templates do Kibana.

5. Configure os agentes Metricbeat e Filebeat.

6. (Opcional) Importe um painel.

Se você tiver algum problema, consulte a seção de Solução de Problemas ou entre em contato com o suporte da Jitterbit.

Pré-requisitos

Para usar o Elasticsearch e o Kibana para monitorar um host de agente privado, você deve ter o seguinte:

• Agente privado 11.37.0.7 ou posterior instalado e em execução.

• Um sistema Elasticsearch e Kibana funcionando, instalado e configurado. Para instalar esses, consulte as seguintes páginas:

  • Elasticsearch

  • Kibana

Instale os agentes Metricbeat e Filebeat

Metricbeat e Filebeat são agentes de coleta de dados que encaminham métricas do agente privado para o seu sistema Elasticsearch/Kibana. Para instalá-los, siga estas etapas:

• Metricbeat:

  1. Para instalar o Metricbeat em um host de agente privado, siga as instruções do Metricbeat no site da Elastic.co.

  2. Para iniciar o Metricbeat quando o host inicializa, siga as instruções de inicialização do Metricbeat no site da Elastic.co.

  3. Para verificar a conexão do Metricbeat com o Elasticsearch, execute o seguinte comando:

     metricbeat test output
     

• Filebeat:

  1. Para instalar o Filebeat em um host de agente privado, siga as instruções do Filebeat no site da Elastic.co.

  2. Para iniciar o Filebeat quando o host inicializa, siga as instruções de inicialização do Filebeat no site da Elastic.co.

  3. Para verificar a conexão do Filebeat com o Elasticsearch, execute o seguinte comando:

     filebeat test output
     

Configurar os agentes Metricbeat e Filebeat

O agente privado Jitterbit inclui um script para configurar o Metricbeat e o Filebeat. Para usá-lo ao instalar pela primeira vez ou ao atualizar de uma instalação baseada no agente privado 11.34, siga estas etapas:

1. Execute o seguinte em um terminal ou PowerShell:

   DockerLinuxWindows

   cd /opt/jitterbit/scripts/
   ./configure_elasticsearch.sh
   

   cd /opt/jitterbit/scripts/
   ./configure_elasticsearch.sh
   

   cd "C:\Program Files\Jitterbit Agent\scripts\"
   .\configure_elasticsearch.ps
   

2. Leia e responda aos seguintes prompts:

   1. Prompt 1:

      *************
      ***WARNING***
      *************
      Installing the metric configurations will backup and overwrite your metricbeat configuration files.
      Do you wish to proceed?
      1) Yes
      2) No
      

      Digite o número correspondente à sua escolha, seguido pela tecla Enter. As opções são as seguintes:

      • 1: Continuar o script. Se você tiver arquivos de configuração existentes do Metricbeat e do Filebeat (/etc/metricbeat/metricbeat.yml e /etc/filebeat/filebeat.yml), cópias de backup serão feitas (/etc/metricbeat/metricbeat.yml.jb.bak e /etc/filebeat/filebeat.yml.jb.bak) e novos serão criados.

      • 2: Pare o script.

   2. Prompt 2:

      *************
      ***WARNING***
      *************
      Turning on Agent observability on the agent will turn on Enhanced Capability feature for the agent.
      Enhanced Capability might affect the operation routing behavior for the agents.
      Do you wish to proceed?
      1) Yes
      2) No
      

      Digite o número correspondente à sua escolha, seguido pela tecla Enter. As opções são as seguintes:

      • 1: Continue o script. Isso define EnhancedCapabilityMetricsEnabled como true na seção [AgentCapability] do jitterbit.conf.

      • 2: Pare o script.

Definir a política de ciclo de vida do índice Kibana

Para definir a política de retenção de dados, siga estas etapas:

1. Abra seu console web do Kibana.

2. Digite políticas de ciclo de vida do índice na barra de pesquisa e selecione a página resultante.

3. Clique no botão Criar política.

4. Na caixa de diálogo Criar política, defina os seguintes valores:

   • Nome da política: private-agent-metrics-policy

5. Ative o botão Fase Quente, em seguida, defina os seguintes valores:

   • Mover dados para a fase quando: 30 dias.

6. Ative o botão Fase Fria, em seguida, defina os seguintes valores:

   • Mover dados para a fase quando: 90 dias.

7. Clique no botão Salvar política, em seguida, feche o painel de resumo.

Criar templates Kibana

Para criar templates, siga estas etapas:

1. Crie o template private-agent-metric-template:

   1. Digite gerenciamento de índice na barra de pesquisa e selecione a página resultante.

   2. Selecione a aba Templates de Índice.

   3. Clique no botão Criar template.

   4. Na página Logística, insira valores para os seguintes campos:

      • Nome: private-agent-metric-template

      • Padrões de índice: private-agent-metric-8.15-*

   5. Clique no botão Próximo .

   6. Na página Templates de componentes, clique no botão Próximo .

   7. Na página de Configurações do índice, substitua o conteúdo do campo Configurações do índice pelo seguinte:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      

   8. Clique no botão Próximo .

   9. Na página de Mapeamentos, na aba Campos mapeados, adicione campos de acordo com a tabela a seguir. Clique no botão Adicionar campo após cada entrada:

      Tipo de campo	Nome do campo
      Keyword	fields.env
      Keyword	private-agent.group
      Keyword	private-agent.name

   10. Selecione a aba Opções avançadas, em seguida, defina os seguintes interruptores como Ativado:

       • Mapear strings numéricas como números

       • Mapear strings de data como datas

   11. Clique no botão Próximo .

   12. Na página de Apelidos, clique no botão Próximo .

   13. Na página de Revisar detalhes, clique no botão Criar template, em seguida, feche o painel de resumo.

2. Crie o template private-agent-filebeat-template:

   1. Na aba de Templates de índice, clique no botão Criar template.

   2. Na página de Logística, insira valores para os seguintes campos:

      • Nome: private-agent-filebeat-template

      • Padrões de índice: private-agent-filebeat-8.15-*

   3. Clique no botão Próximo .

   4. Na página de Templates de componente, clique no botão Próximo .

   5. Na página de Configurações do índice, substitua o conteúdo do campo Configurações do índice pelo seguinte:

      {
        "index": {
          "lifecycle": {
            "name": "private-agent-metrics-policy",
            "rollover_alias": "private-agent-metric-alias"
          },
          "number_of_shards": "1",
          "number_of_replicas": "1"
        }
      }
      

   6. Clique no botão Próximo .

   7. Na página de Mapeamentos, na aba Campos mapeados, adicione campos de acordo com a tabela a seguir. Clique no botão Adicionar campo após cada entrada:

      Tipo de campo	Nome do campo
      Keyword	message.fields.environment_name
      Keyword	message.fields.operation_name
      Keyword	message.fields.project_name
      Keyword	message.fields.status
      Keyword	private-agent.group
      Keyword	private-agent.name

   8. Selecione a aba Opções avançadas, em seguida, defina os seguintes interruptores como Ativado:

      • Mapear strings numéricas como números

      • Mapear strings de data como datas

   9. Clique no botão Próximo .

   10. Na página Aliases, clique no botão Próximo .

   11. Na página Revisar detalhes, clique no botão Criar template, em seguida, feche o painel de resumo.

Importar um dashboard do Elasticsearch

Para importar um dashboard do Elasticsearch pré-construído, siga estas etapas:

1. Baixe o arquivo JSON do Dashboard do Elasticsearch do Jitterbit Private Agent na página Downloads do portal Harmony.

2. Digite kibana saved objects na barra de pesquisa do Elasticsearch, em seguida, selecione a página resultante.

3. Clique no botão Importar.

4. Na caixa de diálogo Importar objetos salvos, clique em Importar, encontre o arquivo JSON do dashboard baixado e, em seguida, selecione-o.

5. Em Opções de importação, selecione Verificar objetos existentes com Substituir conflitos automaticamente.

6. Clique no botão Importar.

7. Clique no botão Concluído.

8. Para usar o dashboard, digite dashboards na barra de pesquisa do Elasticsearch, selecione a página resultante e, em seguida, selecione Dashboard do Jitterbit Harmony Private Agent.

Solucionar problemas do Elasticsearch

Para ajudar a resolver quaisquer problemas com os componentes do Elasticsearch, você pode verificar a documentação do Elasticsearch, inspecionar arquivos de log ou executar comandos de diagnóstico.

Documentação do Elasticsearch

• Metricbeat:

  • Perguntas frequentes do Metricbeat

  • Depurar Metricbeat

• Filebeat:

  • Perguntas frequentes do Filebeat

  • Depurar Filebeat

Localizações dos arquivos de log do Elasticsearch

• /var/log/metricbeat

• /var/log/filebeat