Telemetry API を使用する

Telemetry（OTLP）API を使用して、ログ、指標、トレースを Google Cloud プロジェクトに送信するように Ops エージェントを構成できます。Telemetry API（telemetry.googleapis.com）は、オープンソースの OpenTelemetry プロトコルの実装です。この API を使用するように Ops エージェントを構成すると、Ops エージェントは独自の Cloud Monitoring API、Logging API、Trace API ではなく、Telemetry API を使用してテレメトリーを送信します。

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

始める前に

Telemetry API を使用する手順は次のとおりです。

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

    gcloud services enable telemetry.googleapis.com

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

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

  3. トレースを収集する場合は、Ops エージェントが使用するサービス アカウントに Cloud Telemetry トレース書き込み（roles/telemetry.tracesWriter）ロールを付与します。このロールは、トレースの書き込みに必要な権限を付与します。

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

Ops エージェントには、独自の API（デフォルト）と Telemetry API を使用してテレメトリーを送信する方法を切り替える構成オプションが用意されています。Ops エージェントと Telemetry API を使用してテレメトリーを収集するには、次のセクションで説明するように、次の操作を行う必要があります。

  1. Telemetry API をサポートするバージョンの Ops エージェントをインストールします。
  2. Ops エージェントの config.yaml ファイルを更新して、構成オプションを設定します。
  3. Ops エージェントを再起動して変更を取得します。

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

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

構成オプションを設定する

エージェントの config.yaml ファイルで otlp_exporter 構成オプションを true に設定して、Ops エージェントに Telemetry API へのアクセス権を付与します。

global:
   otlp_exporter: true

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 エージェントを構成する

Telemetry API を使用して Ops エージェントによるテレメトリーの収集を停止し、Cloud Monitoring API、Logging API、Trace API を使用してテレメトリーの収集を再開するには、次の操作を行います。

  1. config.yaml ファイルから otlp_exporter オプションを削除します。または、オプションを false に設定することもできます。

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

次のステップ