Ir para o conteúdo

Observabilidade de agentes privados com Datadog

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 Datadog. Quando configurados, as métricas dos seus agentes privados podem ser visualizadas usando o painel pré-configurado fornecido pela Jitterbit, ou seu próprio painel personalizado.

Para configurar o Datadog, siga as etapas nestas seções na ordem:

  1. Atenda aos pré-requisitos.

  2. Instale o agente Datadog no host do agente privado.

  3. Configure o agente Datadog.

  4. Configure as métricas do Datadog.

  5. (Opcional) Importe um painel do Datadog.

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

Você deve ter o seguinte:

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

  • Uma conta Datadog.

  • Uma conta de superusuário (root) no Linux ou uma conta de Administrador no Windows.

    Importante

    Execute todos os comandos nesta página como este usuário.

  • Um nome de host RFC 1123 válido para o host onde o agente privado está em execução.

  • Requisitos adicionais para agentes privados Docker:

Instalar o agente Datadog

Para instalar o agente Datadog em um host de agente privado, siga estas etapas:

  1. Faça login na sua conta Datadog.

  2. No menu principal, selecione Integrações > Automação de Frota > Instalar Agentes.

  3. Na página Selecionar plataforma para instalar Agentes, selecione a plataforma em que seu agente privado está em execução:

    Selecione Base no Host > Linux.

    Selecione Base no Host > Linux.

    Selecione Host baseado > Windows.

  4. Na página Instalar o Agente Datadog em , existem estas três seções:

    • ① Personalize sua cobertura de observabilidade: Ative os recursos necessários e selecione uma tag de ambiente.

    • ② Execute o comando de instalação:

      1. Clique no botão Selecionar uma Chave de API. O diálogo Selecionar uma Chave de API se abre.

      2. Selecione uma chave de API da lista e clique no botão Usar Chave de API.

        Se você não tiver uma chave, clique no botão Criar Nova para criar uma.

      3. Abra um console (terminal ou PowerShell) no host do agente privado. Copie e cole o bloco de código no console.

      4. Faça o seguinte:

        1. Adicione uma linha para definir o valor da variável de ambiente DD_HOSTNAME para o nome do host do agente privado.

        2. Altere install_script_agent7.sh para install_script_agent6.sh.

          (Atualmente, o agente privado Jitterbit suporta apenas a versão 6 do agente Datadog.)

        3. Seu comando deve ser parecido com isso, com sua própria chave de API (linha 1), nome do host do agente privado (linha 3) e argumento curl editado (linha 4):

          1
2
3
4
          DD_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
DD_SITE="datadoghq.com" \
DD_HOSTNAME="hostname" \
bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent6.sh)"

        4. Pressione Enter para executar os comandos.

        Pressione Enter para executar os comandos.

        Pressione Enter para executar os comandos.

    • ③ Confirme a instalação do Agente: Quando você tiver o agente Datadog instalado e em execução no seu host de agente privado, aguarde um momento para que ele apareça neste painel antes de continuar.

  5. (Apenas Docker) Crie um arquivo de segurança padrão do agente Datadog:

    Após a instalação, o agente Datadog não consegue iniciar devido a um problema conhecido do Datadog. Para corrigir isso, faça uma cópia do arquivo de exemplo de segurança do agente antes de prosseguir para a próxima seção:

cp  /etc/datadog-agent/security-agent.yaml.example /etc/datadog-agent/security-agent.yaml

Nenhuma ação necessária.

Nenhuma ação necessária.

Configure o agente Datadog

O software do agente privado Jitterbit inclui um script para configurar e iniciar o agente Datadog. Você pode usá-lo ao instalar pela primeira vez ou ao atualizar de uma instalação baseada no agente privado 11.34. Para fazer isso, siga estas etapas:

  1. Execute o seguinte em um terminal ou PowerShell no host do agente privado:

    cd /opt/jitterbit/scripts/
./configure_datadog.sh

    cd /opt/jitterbit/scripts/
./configure_datadog.sh

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

  2. Leia e responda aos seguintes prompts:

    1. Prompt 1:

      *************
***WARNING***
*************
Installing the metric configurations will backup and overwrite your datadog 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 um arquivo de configuração do Datadog existente (/etc/datadog-agent/datadog.yaml), uma cópia de backup será feita (/etc/datadog-agent/datadog.yml.jb.bak) e um novo será criado.

      • 2: Parar 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:

    3. Prompt 3:

      Jitterbit agent needs to restart in order to load the new changes.
Do you wish to restart now? This will stop any in progress operations
1) Yes
2) No

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

      • 1: Continue a parar e reiniciar o agente privado, reinicie o agente Datadog e, em seguida, saia do script. Para confirmar que seu agente Datadog está funcionando, faça login na sua conta Datadog e selecione Integrações > Automação de Frota no menu principal.

      • 2: Saia do script sem reiniciar o agente privado ou o agente Datadog. Você deve reiniciar tanto o agente privado quanto o agente Datadog quando for conveniente.

Importante

No Docker, o agente Datadog não inicia automaticamente com o host. Você deve iniciá-lo manualmente com o seguinte comando:

sudo datadog-agent run

Configurar métricas do Datadog

Criar facetas

Para definir facetas do Datadog, siga estas etapas:

  1. Selecione Logs > Explorer.

  2. Na barra Pesquisar por, filtre os logs pelo Host do seu agente e pelo serviço JitterbitAgentMetric usando a seguinte string:

    host:<hostname> service:JitterbitAgentMetric

  3. (Opcional) Verifique se os logs do seu agente estão no formato JSON. Para fazer isso, selecione uma entrada de log recente e verifique se a coluna CONTEÚDO contém uma mensagem de log formatada em JSON.

  4. Na barra Pesquisar facetas, clique no botão Adicionar (Adicionar uma faceta). O diálogo Adicionar faceta é aberto.

  5. No campo Caminho, insira o texto mostrado abaixo e clique no botão Adicionar. Repita para cada item na lista a seguir:

    • @environment_id

    • @environment_name

    • @is_operation_over_schedule

    • @name

    • @operation_id

    • @operation_instance_guid

    • @operation_name

    • @organization_id

    • @project_guid

    • @project_name

    • @status

Criar um campo calculado

Para criar um campo calculado, siga estas etapas:

  1. Selecione Logs > Explorer.

  2. Clique no botão Adicionar e, em seguida, selecione Campo Calculado. O diálogo Criar um campo calculado é aberto.

  3. Defina valores para os seguintes campos:

    • Nome do seu campo: operation_duration_seconds

    • Defina sua fórmula: @fields.duration_seconds

  4. Clique no botão Salvar.

Criar uma medida

Para criar uma medida, siga estas etapas:

  1. Selecione Logs > Explorer.

  2. Na barra Facetas de pesquisa, clique no botão Adicionar (Adicionar uma faceta). A caixa de diálogo Adicionar faceta é aberta.

  3. Selecione a aba Medida.

  4. No campo Caminho, insira @operation_duration_seconds.

  5. Clique no botão Adicionar.

Criar métricas de operação

Para definir métricas de operação, selecione Logs > Gerar Métricas, e siga as etapas abaixo para cada métrica de operação.

Dica

Você também pode usar logs para criar métricas do Datadog.

Criar a métrica de operação metric.operation.count.by.status

  1. Clique no botão Nova Métrica.

  2. Na caixa de diálogo Gerar Métrica, defina os valores da seguinte forma:

    • Defina o Nome da Métrica: metric.operation.count.by.status

    • Defina a Consulta: service:JitterbitAgentMetric @name:operation_log

  3. Clique no menu agrupar por, e clique em cada um dos seguintes para adicioná-los à lista:

    • @fields.operation_id

    • @fields.operation_name

    • @fields.status

    • @agentgroup

    • @host

  4. Clique no botão Criar Métrica.

Criar a métrica de operação metric.operation.running.over.scheduled.interval

  1. Clique no botão Nova Métrica.

  2. Na caixa de diálogo Gerar Métrica, defina os valores da seguinte forma:

    • Defina o Nome da Métrica: metric.operation.running.over.scheduled.interval

    • Defina a Consulta: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Clique no menu agrupar por, e clique em cada um dos seguintes para adicioná-los à lista:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Clique no botão Criar Métrica.

Crie a métrica de operação metric.operation.duration.seconds

  1. Clique no botão Nova Métrica.

  2. Na caixa de diálogo Gerar Métrica, defina os valores da seguinte forma:

    • Definir Nome da Métrica: metric.operation.duration.seconds

    • Definir Consulta: service:JitterbitAgentMetric @name:operation_running_over_scheduled_interval

  3. Clique no menu agrupar por e clique em cada um dos seguintes para adicioná-los à lista:

    • @fields.operation_id

    • @fields.operation_name

    • @agentgroup

    • @host

  4. Clique no botão Criar Métrica.

Crie métricas de processo

Para definir métricas de processo, selecione Infraestrutura > Processos, selecione a aba Gerenciar Métricas e siga os passos abaixo para cada métrica de processo.

Crie a métrica de processo proc.openginebyname.cpu.num_threads

  1. Clique no botão Nova Métrica.

  2. Na seção 1, Filtrar Processos, no campo Filtrar por, insira command:JitterbitOperationEngineProc.

  3. Na seção 2, Selecionar Medida e Dimensões, defina os valores para os seguintes campos:

    • Abra o menu Medida e selecione # de Threads.

    • Abra o menu Dimensões e selecione name.

  4. Na seção 4, Nome, no campo metric.name, insira openginebyname para que o nome seja proc.openginebyname.cpu.num_threads.

  5. Clique no botão Criar.

Crie a métrica de processo proc.operationsengine.cpu.num_threads

  1. Clique no botão Nova Métrica.

  2. Na seção 1, Filtrar Processos, no campo Filtrar por, insira command:JitterbitOperationEngineProc.

  3. Na seção 2, Selecionar Medida e Dimensões, defina os valores para os seguintes campos:

    • Abra o menu Medir, em seguida selecione # de Threads.

    • Abra o menu Dimensões, em seguida selecione agentgroup.

  4. Na seção 4, Nome, no campo metric.name, insira operationsengine para que o nome seja proc.operationsengine.cpu.num_threads.

  5. Clique no botão Criar.

Importar um painel do Datadog

Para importar o painel pré-construído do Datadog da Jitterbit, siga estas etapas:

  1. Baixe o arquivo JSON do Painel do Datadog do Agente Privado Jitterbit da página Downloads do portal Harmony.

  2. Selecione Painéis > Novo Painel.

  3. Na caixa de diálogo Criar um Painel, insira um nome no campo Nome do Painel, em seguida clique no botão Novo Painel.

  4. Clique no botão Configurar, em seguida selecione Importar JSON do painel.

  5. Encontre o arquivo JSON do painel baixado e selecione-o.

  6. Para usar o painel, selecione Painéis > Lista de Painéis, insira Agente Privado Jitterbit Harmony no campo Pesquisar painéis, em seguida selecione o painel importado.

Solucionar problemas do Datadog

Para ajudar a resolver quaisquer problemas com o Datadog, você pode verificar a documentação do Datadog, inspecionar arquivos de log ou executar comandos para gerenciar usuários e permissões.

Documentação do Datadog

Localizações de arquivos do Datadog

Arquivos de log

Os arquivos de log do Datadog podem ser encontrados na seguinte localização:

/var/log/datadog/

/var/log/datadog/

Abra o aplicativo Gerenciador do Agente Datadog, em seguida selecione a aba Log.

Arquivos de configuração

O arquivo de configuração do Datadog pode ser encontrado na seguinte localização:

/etc/datadog-agent/datadog.yaml

/etc/datadog-agent/datadog.yaml

Abra o aplicativo Gerenciador do Agente Datadog, em seguida, selecione a aba Configurações.

Neste arquivo, você deve verificar se possui valores corretos para as seguintes chaves:

  • api_key

  • site

  • $hostname

  • tags

Comandos de usuários e permissões do Datadog

Para criar um usuário e grupo do Datadog, execute estes comandos:

usermod -a -G root dd-agent
usermod -a -G jitterbit dd-agent

Para definir a propriedade do arquivo de configuração do Datadog, execute estes comandos:

chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d/conf.yaml
chown dd-agent:dd-agent /etc/datadog-agent/conf.d/logs.d