Utiliser l'API Telemetry

Ce document explique comment configurer l'agent Ops pour utiliser l'API Telemetry (OTLP), telemetry.googleapis.com. L'API Telemetry est une implémentation du protocole de ligne OpenTelemetry Open Source. Lorsque vous activez cette fonctionnalité, l'agent Ops envoie des journaux et des métriques à votre projet Google Cloud à l'aide de l'API Telemetry plutôt que des API propriétaires Cloud Monitoring et Cloud Logging.

Si vous adoptez l'utilisation de l'API Telemetry dans l'agent Ops et que vous avez des graphiques ou des règles d'alerte qui surveillent votre utilisation de l'API, vous devez mettre à jour ces artefacts pour surveiller le point de terminaison telemetry.googleapis.com plutôt que les points de terminaison monitoring.googleapis.com ou logging.googleapis.com.

Avant de commencer

Pour utiliser l'API Telemetry, procédez comme suit :

  1. Activez l'API Telemetry dans votre projet Google Cloud , si elle ne l'est pas déjà. Vous pouvez activer l'API en exécutant la commande suivante :

    gcloud services enable telemetry.googleapis.com

  2. Ajustez les quotas de l'API Telemetry si les valeurs par défaut ne suffisent pas. L'API Telemetry dispose de quotas distincts de ceux de l'API Cloud Monitoring et de l'API Cloud Logging. Pour en savoir plus sur les quotas et les limites de l'API Telemetry, consultez les ressources suivantes :

    Vous devrez peut-être ajuster ces quotas pour tenir compte du volume de données de télémétrie que vous ingérez.

Configurer l'agent Ops pour utiliser l'API Telemetry

Pendant la période de preview, l'utilisation de l'API Telemetry par l'agent Ops est contrôlée par une variable d'environnement, EXPERIMENTAL_FEATURES. Pour collecter des données de télémétrie à l'aide de l'agent Ops et de l'API Telemetry, vous devez procéder comme suit, comme décrit dans les sections suivantes :

  1. Installez une version de l'agent Ops compatible avec l'API Telemetry.
  2. Définissez la variable d'environnement EXPERIMENTAL_FEATURES.
  3. Redémarrez l'agent Ops pour appliquer la modification.

Utiliser la version 2.66.0 ou ultérieure de l'agent Ops

Pour utiliser l'API Telemetry avec l'agent Ops, vous devez installer l'agent Ops version 2.66.0 ou ultérieure. Pour en savoir plus sur l'installation de l'agent Ops, consultez Installer l'agent Ops sur des VM individuelles.

Définir la variable d'environnement

Donnez à l'agent Ops l'accès à l'API Telemetry en définissant la variable d'environnement EXPERIMENTAL_FEATURES sur la valeur otlp_exporter, comme indiqué dans les onglets suivants :

Linux

Pour modifier l'environnement de l'agent Ops, exécutez les commandes suivantes sur votre instance :

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

Pour modifier l'environnement de l'agent Ops, procédez comme suit :

  1. Connectez-vous à votre instance via RDP ou un outil similaire, et connectez-vous à Windows.
  2. Ouvrez un terminal PowerShell avec des droits d'administrateur en effectuant un clic droit sur l'icône PowerShell, puis en sélectionnant Exécuter en tant qu'administrateur.
  3. Définissez la variable d'environnement EXPERIMENTAL_FEATURES en exécutant la commande PowerShell suivante : 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

Redémarrer l'agent Ops

Linux

  1. Pour redémarrer l'agent, exécutez la commande suivante sur votre instance : 
    sudo systemctl restart google-cloud-ops-agent
  2. Pour vérifier que l'agent a redémarré, exécutez la commande suivante et vérifiez que les composants "Agent de métriques" et "Agent de journalisation" ont démarré : 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Connectez-vous à votre instance via RDP ou un outil similaire, et connectez-vous à Windows.
  2. Ouvrez un terminal PowerShell avec des droits d'administrateur en effectuant un clic droit sur l'icône PowerShell, puis en sélectionnant Exécuter en tant qu'administrateur.
  3. Pour redémarrer l'agent, exécutez la commande PowerShell suivante : 
    Restart-Service google-cloud-ops-agent -Force
  4. Pour vérifier que l'agent a redémarré, exécutez la commande suivante et vérifiez que les composants "Agent de métriques" et "Agent de journalisation" ont démarré : 
    Get-Service google-cloud-ops-agent*

Configurer l'agent Ops pour qu'il n'utilise pas l'API Telemetry

Pour empêcher l'agent Ops de collecter des données de télémétrie à l'aide de l'API Telemetry, et pour reprendre la collecte de données de télémétrie à l'aide de l'API Cloud Monitoring et de l'API Cloud Logging, vous devez procéder comme suit :

  1. Supprimez la variable d'environnement EXPERIMENTAL_FEATURES.

    Linux

    Pour modifier l'environnement de l'agent Ops, exécutez les commandes suivantes sur votre instance :

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

    Windows

    Pour modifier l'environnement de l'agent Ops, procédez comme suit :

    1. Connectez-vous à votre instance via RDP ou un outil similaire, et connectez-vous à Windows.
    2. Ouvrez un terminal PowerShell avec des droits d'administrateur en effectuant un clic droit sur l'icône PowerShell, puis en sélectionnant Exécuter en tant qu'administrateur.
    3. Supprimez la variable d'environnement EXPERIMENTAL_FEATURES en exécutant la commande PowerShell suivante : 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. Redémarrez l'Agent Ops pour appliquer la modification.

Étapes suivantes