Usar a API Telemetry

Este documento descreve como configurar o Agente de operações para usar a API Telemetry (OTLP), telemetry.googleapis.com. A API Telemetry é uma implementação do protocolo de linha OpenTelemetry de código aberto. Quando você ativa esse recurso, o Agente de operações envia registros e métricas para seu projeto Google Cloud usando a API Telemetry em vez das APIs proprietárias API Cloud Monitoring e API Cloud Logging.

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, será necessário atualizar esses artefatos para monitorar o endpoint telemetry.googleapis.com em vez dos endpoints monitoring.googleapis.com ou logging.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.

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

Durante o período de pré-lançamento, o uso da API Telemetry pelo agente de operações é controlado por uma variável de ambiente, EXPERIMENTAL_FEATURES. 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. Defina a variável de ambiente EXPERIMENTAL_FEATURES.
  3. Reinicie o Agente de operações para selecionar a mudança.

Use a versão 2.66.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.66.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.

Defina a variável de ambiente

Dê ao agente de operações acesso à API Telemetry definindo a variável de ambiente EXPERIMENTAL_FEATURES com o valor otlp_exporter, conforme mostrado nas seguintes guias:

Linux

Para modificar o ambiente do Agente de Operações, execute os seguintes comandos na sua instância:

for service in \
        google-cloud-ops-agent \
        google-cloud-ops-agent-fluent-bit \
        google-cloud-ops-agent-opentelemetry-collector \
        ; do
        sudo mkdir -p "/etc/systemd/system/${service}.service.d"
        echo -e '[Service]\nEnvironment="EXPERIMENTAL_FEATURES=otlp_exporter"' | sudo tee "/etc/systemd/system/${service}.service.d/otlp_exporter.conf"
done
sudo systemctl daemon-reload

Windows

Para modificar o ambiente do agente de operações, siga estas etapas:

  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. Execute o seguinte comando do PowerShell para definir a variável de ambiente EXPERIMENTAL_FEATURES: 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

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 a API Cloud Monitoring e a API Cloud Logging, faça o seguinte:

  1. Desative a variável de ambiente EXPERIMENTAL_FEATURES.

    Linux

    Para modificar o ambiente do Agente de Operações, execute os seguintes comandos na sua instância:

    sudo find /etc/systemd/system -name otlp_exporter.conf | sudo xargs rm
sudo systemctl daemon-reload

    Windows

    Para modificar o ambiente do agente de operações, siga estas etapas:

    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. Remova a variável de ambiente EXPERIMENTAL_FEATURES executando o seguinte comando do PowerShell: 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

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

A seguir