Usar a API Telemetry

É possível configurar o Agente de operações para usar a API Telemetry (OTLP) e enviar registros, métricas e rastreamentos para seu projeto Google Cloud . A API Telemetry, telemetry.googleapis.com, é uma implementação do protocolo OpenTelemetry de código aberto. Quando você configura o Agente de operações para usar essa API, ele envia telemetria usando a API Telemetry em vez da API proprietária do Cloud Monitoring, da API Logging ou da API Trace.

Se você adotar o uso da API Telemetry no Agente de operações e tiver gráficos ou políticas de alertas que monitoram o uso da API, atualize esses artefatos para monitorar o endpoint telemetry.googleapis.com em vez dos endpoints monitoring.googleapis.com, logging.googleapis.com ou cloudtrace.googleapis.com.

Antes de começar

Para usar a API Telemetry, faça o seguinte:

  1. Ative a API Telemetry no seu projeto Google Cloud , se ela ainda não estiver ativada. Para ativar a API, execute o seguinte comando:

    gcloud services enable telemetry.googleapis.com

  2. Ajuste as cotas da API Telemetry se os valores padrão não forem suficientes. A API Telemetry tem cotas separadas da API Cloud Monitoring e Cloud Logging. Para informações sobre as cotas e os limites da API Telemetry, consulte o seguinte:

    Talvez seja necessário ajustar essas cotas para acomodar o volume de dados de telemetria ingeridos.

  3. Se você estiver coletando traces, conceda o papel Gravador de traces de telemetria do Cloud (roles/telemetry.tracesWriter) à conta de serviço usada pelo Agente de operações. Esse papel fornece as permissões necessárias para gravar rastreamentos.

Configurar o agente de operações para usar a API Telemetry

O Agente de Operações oferece uma opção de configuração para alternar entre o envio de telemetria usando a API proprietária (o padrão) e a API Telemetry. Para coletar telemetria usando o Agente de operações e a API Telemetry, faça o seguinte, conforme descrito nas seções a seguir:

  1. Instale uma versão do Agente de operações compatível com a API Telemetry.
  2. Atualize o arquivo config.yaml do Agente de operações para definir a opção de configuração.
  3. Reinicie o agente de operações para selecionar a mudança.

Use a versão 2.71.0 ou mais recente do Agente de operações

Para usar a API Telemetry com o Agente de operações, instale a versão 2.71.0 ou mais recente do Agente de operações. Para informações sobre como instalar o agente de operações, consulte Instalar o agente de operações de VMs individuais.

Definir a opção de configuração

Dê ao agente de operações acesso à API Telemetry definindo a opção de configuração otlp_exporter como true no arquivo config.yaml do agente:

global:
   otlp_exporter: true

Reiniciar o agente de operações

Linux

  1. Para reiniciar o agente, execute o seguinte comando na instância: 
    sudo systemctl restart google-cloud-ops-agent
  2. Para confirmar se o agente foi reiniciado, execute o seguinte comando e verifique se os componentes "Agente de métricas" e "Agente do Logging" foram iniciados: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Conecte-se à sua instância usando o RDP ou uma ferramenta semelhante e faça login no Windows.
  2. Abra um terminal do PowerShell com privilégios de administrador. Para isso, clique com o botão direito do mouse no ícone do PowerShell e selecione Executar como administrador
  3. Para reiniciar o agente, execute o seguinte comando do PowerShell: 
    Restart-Service google-cloud-ops-agent -Force
  4. Para confirmar se o agente foi reiniciado, execute o seguinte comando e verifique se os componentes "Agente de métricas" e "Agente do Logging" foram iniciados: 
    Get-Service google-cloud-ops-agent*

Configurar o Agente de Operações para não usar a API Telemetry

Para interromper a coleta de telemetria pelo Agente de operações usando a API Telemetry e retomar a coleta de telemetria usando as APIs Cloud Monitoring, API Logging e Trace, faça o seguinte:

  1. Remova a opção otlp_exporter do arquivo config.yaml. Como alternativa, defina a opção como false.

  2. Reinicie o Agente de operações para selecionar a mudança.

A seguir