アプリリクエストのレイテンシを表示する

アプリケーションからレイテンシデータを収集して表示する方法を学習します。

Google Cloud CLI を使用して Google Kubernetes Engine（GKE）クラスタを作成する。
サンプルアプリケーションをダウンロードして、クラスタにデプロイします。
サンプルアプリケーションに HTTP リクエストを送信してトレースを作成する。
作成したトレースのレイテンシ情報を表示します。
クリーンアップする。

このタスクを Google Cloud コンソールで直接行う際の順を追ったガイダンスについては、「ガイドを表示」をクリックしてください。

始める前に

組織で定義されているセキュリティの制約により、次の手順を完了できない場合があります。トラブルシューティング情報については、制約のある Google Cloud 環境でアプリケーションを開発するをご覧ください。

アカウントにログインします Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオで Google プロダクトのパフォーマンスを評価してください。 Google Cloud新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Google Kubernetes Engine and Cloud Trace APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Google Kubernetes Engine and Cloud Trace APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

必要なロール

Google Kubernetes Engine クラスタの作成とトレーススパンの表示に必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

Kubernetes Engine 管理者（roles/container.admin）
Cloud トレースユーザー（roles/cloudtrace.user）
サービスアカウントユーザー（roles/iam.serviceAccountUser）
Service Usage 管理者（roles/serviceusage.serviceUsageAdmin）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

GKE クラスタを作成する

このガイドでは、標準の GKE クラスタを作成します。Google Kubernetes Engine で Autopilot モードを使用する場合、または Workload Identity Federation for GKE を有効にする場合は、 Workload Identity Federation for GKE を使用するようにアプリケーションを構成する必要があります。

ツールバーで、 [Cloud Shell をアクティブにする] をクリックして、Cloud Shell で次の操作を行います。
クラスタを作成します。
```
gcloud container clusters create cloud-trace-demo --zone us-central1-c
```
上記のコマンド（完了するまでに数分かかる）により、us-central1-c ゾーンに cloud-trace-demo という名前の標準クラスタが作成されます。
Google Cloud CLI と同じ ID を使用する認証情報を自動的に更新するように kubectl を構成します。
```
gcloud container clusters get-credentials cloud-trace-demo --zone us-central1-c
```

クラスタへのアクセスを確認します。

kubectl get nodes

このコマンドの出力例は次のとおりです。

NAME                                              STATUS   ROLES    AGE   VERSION
gke-cloud-trace-demo-default-pool-063c0416-113s   Ready    <none>   78s   v1.22.12-gke.2300
gke-cloud-trace-demo-default-pool-063c0416-1n27   Ready    <none>   79s   v1.22.12-gke.2300
gke-cloud-trace-demo-default-pool-063c0416-frkd   Ready    <none>   78s   v1.22.12-gke.2300

アプリケーションをダウンロードしてデプロイする

Flask フレームワークと OpenTelemetry パッケージを使用する Python アプリケーションをダウンロードして、デプロイします。このアプリケーションについては、このページのアプリについてのセクションをご覧ください。

Cloud Shell で次の操作を行います。

GitHub から Python アプリのクローンを作成します。

git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

次のコマンドを実行して、サンプルアプリケーションをデプロイします。
```
cd python-docs-samples/trace/cloud-trace-demo-app-opentelemetry && ./setup.sh
```
setup.sh スクリプトが完了するまでに数分かかります。

このスクリプトは、ビルド済みのイメージを使用して 3 つのサービスを構成し、すべてのリソースがプロビジョニングされるのを待ちます。ワークロードの名前は cloud-trace-demo-a、cloud-trace-demo-b、cloud-trace-demo-c です。

このコマンドの出力例は次のとおりです。
```
deployment.apps/cloud-trace-demo-a is created
service/cloud-trace-demo-a is created
deployment.apps/cloud-trace-demo-b is created
service/cloud-trace-demo-b is created
deployment.apps/cloud-trace-demo-c is created
service/cloud-trace-demo-c is created

Wait for load balancer initialization complete......
Completed.
```

トレースデータを作成する

1 件のトレースは、アプリケーションが 1 つのオペレーションを完了するまでにかかる時間を表します。

Cloud Shell でトレースを作成するには、次のコマンドを実行します。

curl $(kubectl get svc -o=jsonpath='{.items[?(@.metadata.name=="cloud-trace-demo-a")].status.loadBalancer.ingress[0].ip}')

上記のコマンドのレスポンスは次のようになります。

Hello, I am service A
And I am service B
Hello, I am service C

curl コマンドを複数回実行すると、複数のトレースを生成できます。

レイテンシデータを表示する

Google Cloud コンソールで、 [Trace エクスプローラ] ページに移動します。
[Trace エクスプローラ] に移動

このページは、検索バーを使用して見つけることもできます。

次のスクリーンショットは、curl コマンドを複数回実行した結果を示しています。グラフには、トレースのサブオペレーションを表すスパンの集計レイテンシデータが表示されます。

注: 数分待ってもトレースデータが表示されない場合は、権 101}限に問題がある可能性があります。この問題を解決するには、拡張機能 @developer.gserviceaccount.com を持つサービスアカウントに編集者のロールが付与されているかどうかを確認します。付与されていない場合は、サービスアカウントに Cloud Trace エージェントのロールを付与し、curl コマンドを実行します。
トレースの詳細を表示するには、グラフ内のスパンまたは表内の行を選択します。

次のスクリーンショットに示すように、トレースの詳細ダイアログが開きます。

ガントチャートには、選択したトレースに関する情報が表示されます。ガントチャートの最初の行はトレース用であり、その後の行はトレース内のスパンです。
スパンに関する詳細情報を表示するには、ガントチャートでスパンを選択します。

アプリケーションの概要

このクイックスタートで使用するサンプルアプリケーションは、GitHub リポジトリで入手できます。このリポジトリには、Cloud Shell 以外の環境でアプリケーションを使用する方法に関する情報が含まれています。サンプルアプリケーションは Python で記述されており、Flask フレームワークと OpenTelemetry パッケージを使用して、GKE クラスタ上で実行されます。

計測手法

GitHub リポジトリのファイル app.py には、トレースデータをキャプチャしてプロジェクトに送信するために必要な計測手法が含まれています。 Google Cloud

このアプリケーションは、複数の OpenTelemetry パッケージをインポートします。

from opentelemetry import trace
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
from opentelemetry.instrumentation.flask import FlaskInstrumentor
from opentelemetry.instrumentation.requests import RequestsInstrumentor
from opentelemetry.propagate import set_global_textmap
from opentelemetry.propagators.cloud_trace_propagator import CloudTraceFormatPropagator
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor

このアプリケーションは、トレースコンテキストでウェブリクエストを処理し、他のサービスに対するリクエストや Flask ハンドラを自動的にトレースします。
```
app = flask.Flask(__name__)
FlaskInstrumentor().instrument_app(app)
RequestsInstrumentor().instrument()
```

このアプリケーションでは、Cloud Trace エクスポータをトレースプロバイダとして構成し、トレースコンテキストを Cloud Trace 形式で伝播します。

def configure_exporter(exporter):
    """Configures OpenTelemetry context propagation to use Cloud Trace context

    Args:
        exporter: exporter instance to be configured in the OpenTelemetry tracer provider
    """
    set_global_textmap(CloudTraceFormatPropagator())
    tracer_provider = TracerProvider()
    tracer_provider.add_span_processor(BatchSpanProcessor(exporter))
    trace.set_tracer_provider(tracer_provider)


configure_exporter(CloudTraceSpanExporter())
tracer = trace.get_tracer(__name__)

次のコードスニペットは、Python でリクエストを送信する方法を示しています。 OpenTelemetry は、送信リクエストとともにトレースコンテキストを暗黙的に伝播します。

if endpoint is not None and endpoint != "":
    data = {"body": keyword}
    response = requests.get(
        endpoint,
        params=data,
    )
    return keyword + "\n" + response.text
else:
    return keyword, 200

アプリケーションの仕組み

わかりやすくするために、このセクションではサービス名から cloud-trace-demo を省略しています。たとえば、サービス cloud-trace-demo-c は c として参照されます。

このアプリケーションは、a、b、c という名前の 3 つのサービスを作成します。サービス a はサービス b を呼び出すように設定されており、サービス b はサービス c を呼び出すように設定されています。サービスの構成の詳細については、GitHub リポジトリの YAML ファイルをご覧ください。

このクイックスタートでサービス a に HTTP リクエストを発行したときに、次の curl コマンドを使用しました。

curl $(kubectl get svc -o=jsonpath='{.items[?(@.metadata.name=="cloud-trace-demo-a")].status.loadBalancer.ingress[0].ip}')

curl コマンドは次のように動作します。

kubectl によって、cloud-trace-demo-a という名前のサービスの IP アドレスが取得されます。
次に、curl コマンドによってサービス a に HTTP リクエストが送信されます。
サービス a は HTTP リクエストを受信し、サービス b にリクエストを送信します。
サービス b は HTTP リクエストを受信し、サービス c にリクエストを送信します。
サービス c はサービス b から HTTP リクエストを受け取り、文字列 Hello, I am service C をサービス b に返します。
サービス b はサービス c からレスポンスを受信し、これを文字列 And I am service B に追加して結果をサービス a に返します。
サービス a はサービス b からレスポンスを受信し、これを文字列 Hello, I am service A に追加します。
サービス a からのレスポンスが Cloud Shell に出力されます。

クリーンアップ

このページで使用したリソースについて、 Google Cloud アカウントに課金されないようにするには、次の手順を実施します。

新しいプロジェクトを作成し、プロジェクトが必要でなくなった場合は、プロジェクトを削除します。

既存のプロジェクトを使用した場合は、次のようにします。

クラスタを削除するには、Cloud Shell で次のコマンドを実行します。
```
gcloud container clusters delete cloud-trace-demo --zone us-central1-c
```

次のステップ

サポートされている言語とプラットフォームについては、Cloud Trace の概要をご覧ください。
アプリケーションを計測可能にする方法の詳細については、以下をご覧ください。
[Trace エクスプローラ] ウィンドウの詳細については、トレースを検索して表示するをご覧ください。
GKE クラスタの管理の詳細については、kubectl をご覧ください。

アプリ リクエストのレイテンシを表示する

始める前に

必要なロール

GKE クラスタを作成する

アプリケーションをダウンロードしてデプロイする

トレースデータを作成する

レイテンシ データを表示する

アプリケーションの概要

計測手法

アプリケーションの仕組み

クリーンアップ

次のステップ

アプリリクエストのレイテンシを表示する

レイテンシデータを表示する