Telemetry API verwenden

In diesem Dokument wird beschrieben, wie Sie den Ops-Agent so konfigurieren, dass er die Telemetry (OTLP) API, telemetry.googleapis.com verwendet. Die Telemetry API ist eine Implementierung von dem Open-Source OpenTelemetry-Protokoll. Wenn Sie diese Funktion aktivieren, sendet der Ops-Agent sowohl Logs als auch Messwerte über die Telemetry API an Ihr Google Cloud Projekt und nicht über die proprietäre Cloud Monitoring API und Cloud Logging API.

Wenn Sie die Telemetry API im Ops-Agent verwenden und Diagramme oder Benachrichtigungsrichtlinien haben, mit denen Ihre API-Nutzung überwacht wird, müssen Sie diese Artefakte aktualisieren, um den Endpunkt telemetry.googleapis.com anstelle der Endpunkte monitoring.googleapis.com oder logging.googleapis.com zu überwachen.

Hinweis

So verwenden Sie die Telemetry API:

  1. Aktivieren Sie die Telemetry API in Ihrem Google Cloud Projekt, falls sie noch nicht aktiviert ist. Sie können die API mit dem folgenden Befehl aktivieren:

    gcloud services enable telemetry.googleapis.com

  2. Passen Sie die Kontingente der Telemetry API an, wenn die Standardwerte nicht ausreichen. Die Telemetry API hat separate Kontingente von denen der Cloud Monitoring API und Cloud Logging API. Informationen zu den Kontingenten und Limits für die Telemetry API finden Sie unter:

    Möglicherweise müssen Sie diese Kontingente an das Volumen der erfassten Telemetriedaten anpassen.

Ops-Agent für die Verwendung der Telemetry API konfigurieren

Während des Vorschauzeitraums wird die Verwendung der Telemetry API durch den Ops-Agent über eine Umgebungsvariable gesteuert: EXPERIMENTAL_FEATURES. Wenn Sie Telemetriedaten mit dem Ops-Agent und der Telemetry API erfassen möchten, müssen Sie die folgenden Schritte ausführen, wie in den folgenden Abschnitten beschrieben:

  1. Installieren Sie eine Version des Ops-Agents, die die Telemetry API unterstützt.
  2. Legen Sie die Umgebungsvariable EXPERIMENTAL_FEATURES fest.
  3. Starten Sie den Ops-Agent neu, um die Änderung zu übernehmen.

Ops-Agent Version 2.66.0 oder höher verwenden

Wenn Sie die Telemetry API mit dem Ops-Agent verwenden möchten, müssen Sie den Ops-Agent in Version 2.66.0 oder höher installieren. Informationen zum Installieren des Ops-Agents finden Sie unter Ops-Agent installieren auf einzelnen VMs.

Umgebungsvariable festlegen

Gewähren Sie dem Ops-Agent Zugriff auf die Telemetry API, indem Sie die Umgebungsvariable EXPERIMENTAL_FEATURES auf den Wert otlp_exporter setzen, wie in den folgenden Tabs gezeigt:

Linux

Führen Sie die folgenden Befehle auf der Instanz aus, um die Umgebung für den Ops-Agent zu ändern:

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

So ändern Sie die Umgebung für den Ops-Agent:

  1. Stellen Sie mithilfe von RDP oder einem ähnlichen Tool eine Verbindung zu Ihrer Instanz her und melden Sie sich bei Windows an.
  2. Öffnen Sie ein PowerShell-Terminal mit Administratorberechtigungen. Klicken Sie dazu mit der rechten Maustaste auf das PowerShell-Symbol und wählen Sie Als Administrator ausführen aus.
  3. Legen Sie die Umgebungsvariable EXPERIMENTAL_FEATURES mit dem folgenden PowerShell-Befehl fest: 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

Ops-Agent neu starten

Linux

  1. Führen Sie den folgenden Befehl auf der Instanz aus, um den Agenten neu zu starten: 
    sudo systemctl restart google-cloud-ops-agent
  2. Führen Sie den folgenden Befehl aus, um zu überprüfen, ob der Agent neu gestartet wurde. Prüfen Sie dann, ob die Komponenten „Metrics-Agent“ und „Logging-Agent“ gestartet wurden: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Stellen Sie mithilfe von RDP oder einem ähnlichen Tool eine Verbindung zu Ihrer Instanz her und melden Sie sich bei Windows an.
  2. Öffnen Sie ein PowerShell-Terminal mit Administratorberechtigungen. Klicken Sie dazu mit der rechten Maustaste auf das PowerShell-Symbol und wählen Sie Als Administrator ausführen aus.
  3. Führen Sie den folgenden PowerShell-Befehl aus, um den Agent neu zu starten: 
    Restart-Service google-cloud-ops-agent -Force
  4. Führen Sie den folgenden Befehl aus, um zu überprüfen, ob der Agent neu gestartet wurde. Prüfen Sie dann, ob die Komponenten "Metrics-Agent" und "Logging-Agent" gestartet wurden: 
    Get-Service google-cloud-ops-agent*

Ops-Agent so konfigurieren, dass die Telemetry API nicht verwendet wird

Wenn Sie verhindern möchten, dass der Ops-Agent Telemetriedaten mit der Telemetry API erfasst, und die Erfassung von Telemetriedaten mit der Cloud Monitoring API und der Cloud Logging API wieder aufnehmen möchten, müssen Sie Folgendes tun:

  1. Entfernen Sie die Umgebungsvariable EXPERIMENTAL_FEATURES.

    Linux

    Führen Sie die folgenden Befehle auf der Instanz aus, um die Umgebung für den Ops-Agent zu ändern:

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

    Windows

    So ändern Sie die Umgebung für den Ops-Agent:

    1. Stellen Sie mithilfe von RDP oder einem ähnlichen Tool eine Verbindung zu Ihrer Instanz her und melden Sie sich bei Windows an.
    2. Öffnen Sie ein PowerShell-Terminal mit Administratorberechtigungen. Klicken Sie dazu mit der rechten Maustaste auf das PowerShell-Symbol und wählen Sie Als Administrator ausführen aus.
    3. Entfernen Sie die Umgebungsvariable EXPERIMENTAL_FEATURES mit dem folgenden PowerShell-Befehl: 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. Starten Sie den Ops-Agent neu, um die Änderung zu übernehmen.

Nächste Schritte