Cloud Trace 用の計装

このドキュメントでは、Cloud Trace 用にアプリケーションを計装可能にする方法の概要を簡単に説明します。Cloud Trace の設定の詳細な手順については、言語別の設定ページをご覧ください。

Cloud Trace では、アプリケーションの分散トレースデータを提供します。アプリケーションを計装可能にすると、Cloud Trace コンソールで、1 つのリクエストのレイテンシデータを分析して、アプリケーション全体の集約したレイテンシを確認できます。

アプリケーションを計測するタイミング

トレースデータが自動的に取得されない場合は、このデータを収集するようにアプリケーションを計測する必要があります。

アプリケーション固有の情報を収集するように、アプリケーションを計測できます。いくつかのオープンソースの計測化フレームワークを使用すると、アプリケーションから指標、ログ、トレースを収集してデータを Google Cloudなどのベンダーに送信できます。アプリケーションを計装化する場合は、ベンダー固有またはプロダクト固有の API やクライアントライブラリではなく、 OpenTelemetryなどのオープンソースの計装化フレームワークを使用することをおすすめします。

ベンダーに依存しないインストルメンテーションフレームワークを使用したアプリケーションのインストルメント化の詳細については、インストルメンテーションとオブザーバビリティをご覧ください。

アプリケーションの計測方法

トレースデータを収集するようにアプリケーションをインストルメント化するには、次のいずれかを行います。

次のプログラミング言語では、OpenTelemetry と関連する Cloud Trace エクスポータを使用できます。

OpenTelemetry SDK	例
Go SDK	Go サンプル
Java SDK	Java サンプル
Node.js SDK	Node.js サンプル
Python SDK	Python サンプル
C++ SDK	C++ サンプル
Ruby SDK	OpenTelemetry ドキュメントをご覧ください。

OpenTelemetry を使用して、データを OTLP エンドポイントに送信できます。このエンドポイントの詳細と、このエンドポイントをおすすめする理由については、 Trace エクスポータから OTLP エンドポイントに移行するをご覧ください。
Compute Engine で動作するアプリケーションを作成する場合は、Ops エージェントと OpenTelemetry Protocol（OTLP）レシーバを使用して、アプリケーションからトレースと指標を収集することもできます。Ops エージェントはログも収集できますが、OTLP を使用して収集することはできません。詳細については、Ops エージェントと OTLP を使用すると Ops エージェントの概要をご覧ください。
クライアントライブラリを使用するか、 Cloud Trace API を直接呼び出して、トレースデータを Cloud Trace に送信できます。ただし、言語がそのライブラリでサポートされている場合は、OpenTelemetry を使用することをおすすめします。
収集したトレースデータを Cloud Trace に転送するよう Spring Boot アプリケーションを構成できます。この手順については、 Spring Cloud for Google Cloud：Cloud Traceをご覧ください。

スパンを作成するタイミング

Cloud Trace クライアントライブラリには通常、現在のスパンに関する情報（トレース ID やトレースがサンプリングされるかどうかなど）を保持するグローバルトレースコンテキストが保持されています。これらのライブラリでは通常、RPC の境界にスパンが作成されます。ただし、デフォルトの作成アルゴリズムではニーズを満たせない場合は、ユーザーがスパンを作成する必要があります。

現在アクティブなスパンには、Tracer オブジェクトでラップされることもあるグローバルトレースコンテキストからアクセスできます。アプリケーションに関連する情報をカスタムアノテーションとタグを使用して、既存のスパンに追加できます。また、独自のアノテーションとタグで新しい子スパンを作成して、アプリケーションの動作を詳細にトレースすることもできます。コンテキストはグローバルであるため、コンテキストを更新するマルチスレッドのアプリケーションは適切な隔離を使用する必要があります。

認証情報を提供するタイミング

上で実行する場合、一般的にアプリケーションに認証情報を提供したり、アプリケーションでプロジェクト ID を指定する必要はありません。 Google Cloud Google Cloud一部の言語では、プロジェクト ID を指定する必要があります。 Google Cloud 上で実行されている場合でも、 Google Cloudまた、Google Kubernetes Engine で Autopilot モードを使用する場合、または Workload Identity Federation for GKE を有効にする場合は、Workload Identity Federation for GKE を使用するようにアプリケーションを構成する必要があります。

の外部で実行している場合は、アプリケーションに認証情報を提供する必要があります。 Google Cloudまた、アプリケーションでプロジェクト ID を指定する必要もあります。Google Cloud

詳しくは、言語別の設定ページをご覧ください。

リクエストを強制的にトレースする方法

アプリケーションが常にすべてのスパンをサンプリングしない限り、一般に、リクエストをエンドツーエンドでトレースすることはできません。それは、エンドツーエンドリクエストの各コンポーネントはサンプリングの決定を独自に行うためです。ただし、トレースヘッダーに sampled フラグを追加し、このフラグを true に設定することで、決定に影響を与えることができます。この設定は、リクエストをサンプリングするように子コンポーネントにヒントを与えます。トレースヘッダーの詳細については、コンテキスト伝播のプロトコルをご覧ください。

コードを所有するダウンストリームコンポーネントの場合は、計測ロジックが sampled フラグを考慮しているかどうかを判断する必要があります。たとえば、計測に OpenTelemetry を使用する場合、ParentBased サンプラーを使用すると、親のサンプリングフラグが考慮されます。

Google Cloud 通常、トレース情報を Cloud Trace に記録するサービスでは、親サンプリングフラグをヒントとして受け入れますが、ほとんどのサービスでレート制限のサンプリングも行われます。各 Google Cloud サービスは、トレースをサポートするかどうか、親サンプリングフラグの使用方法、サンプリングのレート制限を決定します。

指標データとトレースデータを関連付ける方法

指標データポイントにエグザンプラをアタッチすることで、分布値の指標データをトレースに関連付けることができます。必要な構成手順を完了すると、推奨される計測ライブラリである OpenTelemetry によって、これらのエグザンプラが自動的に追加されます。詳細については、エグザンプラを使用して指標とトレースを関連付けるをご覧ください。

プロジェクトとプラットフォームを構成する

Cloud Trace API が有効になっていることを確認します。

デフォルトでは、 Google Cloud プロジェクトで Cloud Trace API が有効になっているため、何もする必要はありません。ただし、組織で定義されているセキュリティの制約により、API が無効になっている可能性があります。トラブルシューティング情報については、制約のある Google Cloud 環境でアプリケーションを開発するをご覧ください。

Cloud Trace API を有効にします。
API を有効にするために必要なロール
API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。ロールを付与する方法を確認する。
API の有効化
プラットフォームを構成する。

Cloud Trace は Google Cloud と他のプラットフォームで使用できます。
- Google Cloud: アプリケーションが Google Cloudで実行されている場合、認証情報をサービスアカウントの形式でクライアントライブラリに提供する必要はありません。ただし、は、 Google Cloud プラットフォームで Cloud Trace API のアクセススコープが有効になっていることを確認する必要があります。
  
  次の構成では、デフォルトのアクセススコープ設定に Cloud Trace API アクセススコープが含まれています。
  - Compute Engine
  - Google Kubernetes Engine（GKE）
    
    注: Autopilot を使用している場合、または GKE クラスタで Workload Identity Federation for GKE を有効にする場合は、Workload Identity Federation for GKE を使用するようにアプリケーションを構成します。
  - App Engine フレキシブル環境
  - App Engine スタンダード環境
  - Cloud Run
  カスタムアクセススコープを使用する場合は、Cloud Trace API のアクセススコープを有効にする必要があります。たとえば、Google Cloud CLI を使用して GKE クラスタを作成し、--scopes フラグを指定する場合は、スコープに trace.append が含まれていることを確認します。次のコマンドは、--scopes フラグの設定を示しています。
```
gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
```
- ローカルおよびその他の場所で実行する場合: アプリケーションが Google Cloudの外部で実行されている場合は、認証情報をサービスアカウントの形式でクライアントライブラリに提供する必要があります。サービスアカウントには、Cloud Trace エージェント（roles/cloudtrace.agent）ロールが付与されている必要があります。ロールの詳細については、 IAM によるアクセス制御をご覧ください。
  
  Google Cloud クライアントライブラリは、アプリケーションのデフォルト認証情報（ADC）を使用してアプリケーションの認証情報を検索します。これらの認証情報を指定するには、次の 3 つの方法があります。
  - 実行 gcloud auth application-default login
  - オペレーティングシステムのデフォルトパスにサービスアカウントを配置します。以下に、Windows と Linux のデフォルトのパスを一覧表示します。
    - Windows: %APPDATA%/gcloud/application_default_credentials.json
    - Linux: $HOME/.config/gcloud/application_default_credentials.json
  - GOOGLE_APPLICATION_CREDENTIALS 環境変数をサービスアカウントのパスに設定します。
    Linux / macOS
    
    export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
    Windows
    
    set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
    
    PowerShell:
    
    $env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"

次のステップ

GitHub やその他のオープンソースリポジトリへの詳細な構成情報、サンプル、リンクについては、ご使用の言語の設定ページをご覧ください。

OpenTelemetry の例: