このドキュメントでは、トレーススコープを作成して管理する方法について説明します。トレーススコープを使用すると、トレース エクスプローラ ページで、表示または分析するトレース スパンを見つけることができます。 Google Cloud プロジェクトで発生したスパンのみを表示して分析する場合は、トレース スコープを構成する必要はありません。ただし、マイクロサービス アーキテクチャを使用する場合など、トレースデータが複数のプロジェクトに保存されている場合は、1 つのプロジェクトからすべてのスパンを表示するために、いくつかの構成アクティビティを実行する必要があります。 Google Cloud
このドキュメントでは、トレースとスパンを表示する方法については説明しません。このトピックの詳細については、トレースを検索して調査するをご覧ください。
この機能は Google Cloud プロジェクトでのみサポートされています。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
トレース スコープについて
トレース スコープは、一連の Google Cloud プロジェクトのリストを取得するプロジェクト レベルの永続的なリソースです。トレース スコープで検索するように [Trace エクスプローラ] ページを構成できます。つまり、選択したスコープに一覧表示されているプロジェクトがページで検索されます。ストレージからフェッチされて表示されるデータは、検索対象のプロジェクトに対する Identity and Access Management（IAM）ロールと期間の設定によって決まります。
Google Cloud プロジェクトを作成すると、_Default という名前のトレース スコープが作成されます。このスコープには Google Cloud プロジェクトのみが含まれます。このスコープにプロジェクトを追加したり、このスコープを削除したりすることはできません。
トレース スコープを作成できます。また、作成したトレース スコープの変更と削除も可能です。スパンデータを複数の Google Cloud プロジェクトに書き込むサービスがある場合は、トレース スコープを作成します。
トレース スコープまたはトレース ID とスパン ID を含む URL で [Trace エクスプローラ] ページを開かない限り、[Trace エクスプローラ] ページは、デフォルトのトレース スコープに一覧表示されているGoogle Cloud プロジェクトでトレースデータを検索します。プロジェクトを作成すると、_Default という名前のトレース スコープがデフォルトのトレース スコープとして設定されます。ただし、別のトレース スコープを選択して、デフォルトのトレース スコープとして使用できます。
App Hub のアプリケーションとトレーススコープ
App Hub アプリケーションは、トレースデータを複数のプロジェクトに書き込む場合があります。このデータの集計ビューを取得するには、トレース スコープを作成し、トレースデータを保存するすべてのプロジェクトを一覧表示するように構成してから、デフォルトのトレース スコープとして構成します。これらの手順を完了すると、アプリケーションによって書き込まれたデータが [Trace エクスプローラ] ページに自動的に表示されます。このデータは、異なるプロジェクトに保存されている場合でも表示されます。
ログデータを表示するプロジェクトにカスタム トレーススコープを作成します。このプロジェクトは、App Hub ホスト プロジェクトか、アプリ対応フォルダの管理プロジェクトです。たとえば、フォルダの表示名が My Folder の場合、管理プロジェクトの表示名は My Folder-mp になります。
始める前に
トレース スコープの作成と表示に必要な権限を取得するには、プロジェクトに対する Cloud Trace ユーザー （roles/cloudtrace.user）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。
この事前定義ロールには、トレーススコープの作成と表示に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。
必要な権限
トレース スコープを作成して表示するには、次の権限が必要です。
-
トレース スコープを作成、管理する:
cloudtrace.traceScopes.{create, delete, get, list, update}
カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。
デフォルトのトレース スコープを設定するには、追加の権限が必要です。これらの権限については、このドキュメントのデフォルトのトレース スコープを構成するセクションで説明しています。
トレース スコープを一覧表示する
コンソール
トレーススコープを一覧表示するには、次の操作を行います。
-
Google Cloud コンソールで [settings 設定] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
- Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
[トレース スコープ] タブを選択します。
表にトレーススコープが一覧表示されます。 Google Cloud プロジェクトを選択すると、1 つのエントリにデフォルト アイコン
が表示されます。これは、そのエントリがデフォルトのトレース スコープであることを示します。[Trace エクスプローラ] ページは、ページが開いたときに、デフォルトのトレース スコープにリストされているプロジェクトでトレースデータを検索します。
トレース スコープを作成する
[Trace エクスプローラ] ページに表示されるスパンは、検索されたプロジェクト、それらのプロジェクトに対する IAM ロール、期間の設定、適用したフィルタによって異なります。
プロジェクトごとに作成できるトレース スコープは 100 個までです。トレース スコープには、合計 20 個のプロジェクトを含めることができます。
コンソール
トレース スコープを作成するには、次の操作を行います。
-
Google Cloud コンソールで [settings 設定] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
- Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
- [トレースのスコープ] タブを選択し、[トレースのスコープを作成] をクリックします。
[プロジェクトを追加] をクリックして、ダイアログを完了します。
プロジェクトを追加すると、そのプロジェクトに保存されているスパンがトレース スコープに含まれます。スコープに含めるプロジェクトがわからない場合は、以前の トレース エクスプローラ ページを使用して特定できます。詳細については、このドキュメントのトレース スコープに移行するをご覧ください。
[トレース スコープの指定] セクションで、[トレース スコープ] タブに表示する名前と説明を入力します。
トレース スコープの名前は変更できません。また、プロジェクト内で一意にする必要があります。
[トレーススコープを作成] をクリックします。
トレース スコープに移行する
[Trace エクスプローラ] ページでは、トレースデータの検索対象となるGoogle Cloud プロジェクトを指定する必要があります。これは、以前の [Trace エクスプローラ] ページからの動作の変更です。以前の [Trace エクスプローラ] ページでは、組織内のすべてのプロジェクトが検索されます。これらの違いにより、[Trace エクスプローラ] ページに、以前の [Trace エクスプローラ] ページに表示されるスパンが表示されないことがあります。
以前の [Trace エクスプローラ] ページの [トレースの詳細] ペイン セクションを使用すると、トレースデータを保存するGoogle Cloud プロジェクトのリストをコンパイルできます。
以前の Trace エクスプローラ ページに移動します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
トレースを選択します。
次の方法をお試しください。
- [トレース ID] フィールドに ID を入力してトレースを表示する。
- フィルタを追加しています。
[トレースの詳細] ペインでトレースを選択し、[プロジェクト] タブに移動します。
このタブには、トレースのスパンを保存するプロジェクトが一覧表示されます。
リストされているプロジェクトを含むトレース スコープを作成するには、[プロジェクト] タブのツールバーに移動して [これらのプロジェクトを含むスコープを作成] を選択し、ダイアログを完了します。
プロジェクトのリストが作成されるまで、上記の手順を繰り返します。
プロジェクトのリストをコンパイルしたら、トレーススコープを作成します。デフォルトのトレース スコープとして設定することもできます。
トレーススコープを変更または削除する
_Default という名前のトレース スコープを削除または変更することはできません。他のすべてのトレース スコープは変更または削除できます。
コンソール
トレーススコープを変更または削除する手順は次のとおりです。
-
Google Cloud コンソールで [settings 設定] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
- Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
- [トレース スコープ] タブを選択します。
変更または削除するトレース スコープを見つけて、[more_vert その他] をクリックしてから、次のいずれかを行います。
- 変更するには、[スコープの編集] を選択して、ダイアログを完了します。
- 削除するには、[スコープの削除] を選択して、ダイアログを完了します。
デフォルトのトレース スコープを構成する
[Trace エクスプローラ] ページが開くと、デフォルトのトレース スコープにリストされているプロジェクトでトレースデータが検索されます。そのトレース スコープにアクセスできない場合は、プロジェクトでトレースデータが検索されます。
プロジェクトが作成されると、_Default という名前のトレース スコープが作成され、デフォルトのトレース スコープとして指定されます。ただし、独自のトレース スコープを作成して、デフォルトのトレース スコープとして指定することはできます。
始める前に
-
Enable the Observability API.
API を有効にする前に、正しいプロジェクトが選択されていることを確認します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
-
トレース スコープの作成と表示、デフォルトのトレース スコープの設定に必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。
-
Cloud トレース ユーザー（
roles/cloudtrace.user） -
オブザーバビリティ編集者 （
roles/observability.editor）
ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。
これらの事前定義ロールには、トレーススコープの作成と表示、デフォルトのトレーススコープの設定に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。
必要な権限
トレーススコープの作成と表示、デフォルトのトレーススコープの設定には、次の権限が必要です。
-
トレース スコープを作成、管理する:
cloudtrace.traceScopes.{create, delete, get, list, update} -
デフォルトのトレース スコープを設定する:
observability.scopes.{get, update}
-
Cloud トレース ユーザー（
デフォルトのスコープを設定する
コンソール
デフォルトのトレース スコープを設定するには、次の操作を行います。
-
Google Cloud コンソールで [settings 設定] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
- Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
[トレース スコープ] タブを選択します。
このタブにはトレース スコープが表示され、カスタム トレース スコープを作成するボタンがあります。
デフォルトのトレーススコープとして指定するトレーススコープを見つけて、その more_vert [その他] をクリックし、[デフォルトに設定] を選択します。
選択したトレース スコープにデフォルト アイコン
が表示されます。
制限事項
トレース スコープの作成や管理は、Cloud Trace API や Google Cloud CLI ではサポートされていません。
トレース スコープの上限
| トレース スコープの上限 | 値 |
|---|---|
| プロジェクトあたりのトレース スコープの最大数 | 100 |
| トレース スコープあたりの最大プロジェクト数 | 20 |
次のステップ
Cloud Logging と Cloud Monitoring には、表示またはモニタリングできるログデータまたは指標データを制御できる同様の構成要素が含まれています。これらのスコープについては、次のドキュメントをご覧ください。