Utilizzare l'API Telemetry

Questo documento descrive come configurare Ops Agent per utilizzare l' API Telemetry (OTLP), telemetry.googleapis.com. L'API Telemetry è un'implementazione di del protocollo OpenTelemetry Line open source. Quando abiliti questa funzionalità, Ops Agent invia sia i log sia le metriche al tuo Google Cloud progetto utilizzando l' API Telemetry anziché le API proprietarie API Cloud Monitoring e API Cloud Logging.

Se adotti l'utilizzo dell'API Telemetry in Ops Agent e hai grafici o criteri di avviso che monitorano l'utilizzo dell'API, devi aggiornare questi artefatti per monitorare l'endpoint telemetry.googleapis.com anziché gli endpoint monitoring.googleapis.com o logging.googleapis.com.

Prima di iniziare

Per utilizzare l'API Telemetry:

  1. Abilita l'API Telemetry nel tuo Google Cloud progetto, se non è già abilitata. Puoi abilitare l'API eseguendo il seguente comando:

    gcloud services enable telemetry.googleapis.com

  2. Modifica le quote dell'API Telemetry, se i valori predefiniti non sono sufficienti. L'API Telemetry ha quote separate da quelle delle API Cloud Monitoring e Cloud Logging. Per informazioni sulle quote e sui limiti dell'API Telemetry, consulta quanto segue:

    Potresti dover modificare queste quote per adattarle al volume di dati di telemetria che importi.

Configura Ops Agent per utilizzare l'API Telemetry

Durante il periodo di anteprima, l'utilizzo dell'API Telemetry da parte di Ops Agent è controllato da una variabile di ambiente, EXPERIMENTAL_FEATURES. Per raccogliere dati di telemetria utilizzando Ops Agent e l'API Telemetry, devi eseguire le seguenti operazioni, come descritto nelle sezioni seguenti:

  1. Installa una versione di Ops Agent che supporti l'API Telemetry.
  2. Imposta la variabile di ambiente EXPERIMENTAL_FEATURES.
  3. Riavvia Ops Agent per applicare la modifica.

Utilizza Ops Agent versione 2.66.0 o successive

Per utilizzare l'API Telemetry con Ops Agent, devi installare Ops Agent versione 2.66.0 o successive. Per informazioni sull'installazione di Ops Agent, consulta Installa Ops Agent su singole VM.

Imposta la variabile di ambiente

Concedi a Ops Agent l'accesso all'API Telemetry impostando la variabile di ambiente EXPERIMENTAL_FEATURES sul valore otlp_exporter, come mostrato nelle seguenti schede:

Linux

Per modificare l'ambiente di Ops Agent, esegui i seguenti comandi sull'istanza:

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

Per modificare l'ambiente di Ops Agent:

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile ed esegui l'accesso a Windows.
  2. Apri un terminale PowerShell con privilegi di amministratore facendo clic con il tasto destro del mouse sull'icona di PowerShell e selezionando Esegui come amministratore
  3. Imposta la variabile di ambiente EXPERIMENTAL_FEATURES eseguendo il seguente comando PowerShell: 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

Riavvia Ops Agent

Linux

  1. Per riavviare l'agente, esegui il seguente comando sull'istanza: 
    sudo systemctl restart google-cloud-ops-agent
  2. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Agente Metriche" e "Agente Logging" siano stati avviati: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile ed esegui l'accesso a Windows.
  2. Apri un terminale PowerShell con privilegi di amministratore facendo clic con il tasto destro del mouse sull'icona di PowerShell e selezionando Esegui come amministratore
  3. Per riavviare l'agente, esegui il seguente comando PowerShell: 
    Restart-Service google-cloud-ops-agent -Force
  4. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Agente Metriche" e "Agente Logging" siano stati avviati: 
    Get-Service google-cloud-ops-agent*

Configura Ops Agent in modo che non utilizzi l'API Telemetry

Per impedire a Ops Agent di raccogliere dati di telemetria utilizzando l'API Telemetry e riprendere la raccolta di dati di telemetria utilizzando le API Cloud Monitoring e Cloud Logging, devi:

  1. Annulla l'impostazione della variabile di ambiente EXPERIMENTAL_FEATURES.

    Linux

    Per modificare l'ambiente di Ops Agent, esegui i seguenti comandi sull'istanza:

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

    Windows

    Per modificare l'ambiente di Ops Agent:

    1. Connettiti all'istanza utilizzando RDP o uno strumento simile ed esegui l'accesso a Windows.
    2. Apri un terminale PowerShell con privilegi di amministratore facendo clic con il tasto destro del mouse sull'icona di PowerShell e selezionando Esegui come amministratore
    3. Rimuovi la variabile di ambiente EXPERIMENTAL_FEATURES eseguendo il seguente comando PowerShell: 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. Riavvia Ops Agent per applicare la modifica.

Passaggi successivi