Telemetry API を使用する

このドキュメントでは、 Telemetry（OTLP）API を使用するように Ops エージェントを構成する方法について説明します telemetry.googleapis.com。Telemetry API は、 オープンソースの OpenTelemetry Line Protocol の実装です。この機能を有効にすると、 Ops エージェントは、独自の Cloud Monitoring API と Cloud Logging API ではなく、 Telemetry API を使用してログと指標の両方を Google Cloud プロジェクトに送信します。

Ops エージェントで Telemetry API を使用し、API の使用状況をモニタリングするグラフまたはアラート ポリシーがある場合は、monitoring.googleapis.com エンドポイントまたは logging.googleapis.com エンドポイントではなく、telemetry.googleapis.com エンドポイントをモニタリングするようにこれらのアーティファクトを更新する必要があります。

始める前に

Telemetry API を使用するには、次の操作を行います。

  1. プロジェクトで Telemetry API が有効になっていない場合は、有効にします。 Google Cloud API を有効にするには、次のコマンドを実行します。

    gcloud services enable telemetry.googleapis.com

  2. デフォルト値で十分でない場合は、Telemetry API の割り当てを調整します。 Telemetry API には、Cloud Monitoring API と Cloud Logging API とは別の割り当てがあります。Telemetry API の割り当てと上限については、以下をご覧ください。

    取り込むテレメトリー データの量に合わせて、これらの割り当てを調整する必要がある場合があります。

Telemetry API を使用するように Ops エージェントを構成する

プレビュー期間中、Ops エージェントによる Telemetry API の使用は、環境変数 EXPERIMENTAL_FEATURES によって制御されます。 Ops エージェントと Telemetry API を使用してテレメトリーを収集するには、次のセクションで説明するように、次の操作を行う必要があります。

  1. Telemetry API をサポートするバージョンの Ops エージェントをインストールします。
  2. EXPERIMENTAL_FEATURES 環境変数を設定します。
  3. Ops エージェントを再起動して変更を反映します。

Ops エージェント バージョン 2.66.0 以降を使用する

Ops エージェントで Telemetry API を使用するには、Ops エージェント バージョン 2.66.0 以降をインストールする必要があります。 Ops エージェントのインストールについては、Ops エージェントをインストールする 個々の VMをご覧ください。

環境変数を設定する

次のタブに示すように、EXPERIMENTAL_FEATURES 環境変数を値 otlp_exporter に設定して、Ops エージェントに Telemetry API へのアクセス権を付与します。

Linux

Ops エージェントの環境を変更するには、インスタンスで次のコマンドを実行します。

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

Ops エージェントの環境を変更する手順は次のとおりです。

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。
  2. PowerShell アイコンを右クリックし、[**管理者として実行**] を選択して、管理者権限で PowerShell ターミナルを開きます。
  3. 次の PowerShell コマンドを実行して、EXPERIMENTAL_FEATURES 環境変数を設定します。 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

Ops エージェントを再起動する

Linux

  1. エージェントを再起動するには、インスタンスで次のコマンドを実行します。
    sudo systemctl restart google-cloud-ops-agent
  2. エージェントが再起動したことを確認するには、次のコマンドを実行して「Metrics エージェント」と「Logging エージェント」のコンポーネントが起動したことを確認します。
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。
  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。
  3. エージェントを再起動するには、次の PowerShell コマンドを実行します。
    Restart-Service google-cloud-ops-agent -Force
  4. エージェントが再起動したことを確認するには、次のコマンドを実行して 「Metrics エージェント」と「Logging エージェント」のコンポーネントが起動したことを確認します。 
    Get-Service google-cloud-ops-agent*

Telemetry API を使用しないように Ops エージェントを構成する

Ops エージェントが Telemetry API を使用してテレメトリーを収集しないようにし、Cloud Monitoring API と Cloud Logging API を使用してテレメトリーの収集を再開するには、次の操作を行う必要があります。

  1. EXPERIMENTAL_FEATURES 環境変数を設定解除します。

    Linux

    Ops エージェントの環境を変更するには、インスタンスで次のコマンドを実行します。

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

    Windows

    Ops エージェントの環境を変更する手順は次のとおりです。

    1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。
    2. PowerShell アイコンを右クリックし、[**管理者として実行**] を選択して、管理者権限で PowerShell ターミナルを開きます。
    3. 次の PowerShell コマンドを実行して、EXPERIMENTAL_FEATURES 環境変数を削除します。 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. Ops エージェントを再起動して変更を反映します。

次のステップ