ログスコープを作成、管理する

コンソール

ログスコープを一覧表示するには、次の操作を行います。

1. Google Cloud コンソールで [settings 設定] ページに移動します。

   [設定] に移動

   このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

2. Google Cloud コンソールのツールバーで、プロジェクト、フォルダ、または組織を選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

3. [ログスコープ] タブを選択します。

   表にログスコープが一覧表示されます。 Google Cloud プロジェクトを選択すると、表内の 1 つのエントリにデフォルト アイコン が表示されます。これは、そのページが開いたときにログ エクスプローラによって検索されるリソースが、このログスコープで一覧表示されることを示します。

gcloud

プロジェクトのログスコープの一覧を取得するには、gcloud logging scopes list コマンドを使用します。

 gcloud logging scopes list --project=PROJECT_ID

コマンドを実行する前に、次のフィールドを更新します。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

プロジェクトのログスコープの詳細を取得するには、gcloud logging scopes describe コマンドを使用します。

 gcloud logging scopes describe LOG_SCOPE_ID --project=PROJECT_ID

コマンドを実行する前に、次のフィールドを更新します。

• PROJECT_ID: プロジェクトの ID。
• LOG_SCOPE_ID: ログスコープの ID。例: my-scope

Terraform

Terraform を使用してログスコープの作成と変更を行うことができます。ただし、Terraform でログスコープの一覧を取得することはできません。

REST

Cloud Logging API には、リソースのログスコープの一覧を取得するコマンドや、特定のログスコープの詳細を報告するコマンドがあります。コマンドの一覧については、API リファレンス ドキュメントをご覧ください。

Google Cloud プロジェクトの場合は、次のコマンドを使用します。

• projects.locations.logScopes.list
• projects.locations.logScopes.get

上記のコマンドの parent フィールドの構文は次のとおりです。

projects/PROJECT_ID/locations/LOCATION_ID

前の式のフィールドの意味は次のとおりです。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOCATION_ID は global に設定する必要があります。

コンソール

プロジェクトのデフォルトのログスコープを設定するには、次の操作を行います。

1. Enable the Observability API.

   Enable the API

   Observability API を有効にする前に、正しいプロジェクトが選択されていることを確認します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。. 設定できるのは、プロジェクトのデフォルトのログスコープのみです。

3. Google Cloud コンソールで [settings 設定] ページに移動します。

   [設定] に移動

   このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

   [設定] ページには、いくつかのタブがあります。各タブには、特定のテレメトリー タイプのスコープ構成が表示されます。

4. [ログスコープ] タブを選択します。

5. デフォルトのログスコープとして指定するログスコープを見つけて、[more_vert その他] をクリックし、[デフォルトに設定] を選択します。

   選択したログスコープにデフォルト アイコン が表示されます。

gcloud

デフォルトのオブザーバビリティ スコープを表示して設定するには、次の操作を行います。

1. デフォルト スコープの設定を表示するには、gcloud observability scopes describe コマンドを実行します。

   後述のコマンドデータを使用する前に、次のように置き換えます。

   • OBSERVABILITY_SCOPE_ID: Scope オブジェクトの名前。この値は _Default に設定する必要があります。
   • LOCATION: ロケーション フィールドは global に設定する必要があります。
   • PROJECT_ID: プロジェクトの ID。

   gcloud observability scopes describe コマンドを実行します。

   Linux、macOS、Cloud Shell

   gcloud observability scopes describe OBSERVABILITY_SCOPE_ID \
      --location=LOCATION\
      --project=PROJECT_ID

   Windows（PowerShell）

   gcloud observability scopes describe OBSERVABILITY_SCOPE_ID `
      --location=LOCATION`
      --project=PROJECT_ID

   Windows（cmd.exe）

   gcloud observability scopes describe OBSERVABILITY_SCOPE_ID ^
      --location=LOCATION^
      --project=PROJECT_ID

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

   logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default
   name: projects/my-project/locations/global/scopes/_Default
   

2. デフォルトのスコープを更新するには、gcloud observability scopes update コマンドを実行します。

   後述のコマンドデータを使用する前に、次のように置き換えます。

   • OBSERVABILITY_SCOPE_ID: Scope オブジェクトの名前。この値は _Default に設定する必要があります。
   • LOG_SCOPE_FQN_ID: ログスコープの完全修飾 ID。このフィールドの形式は次のとおりです。

     logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION/logScopes/LOG_SCOPE_ID

     上記の式で、LOG_SCOPE_ID はログスコープの ID です。例: my-scope。

   • LOCATION: ロケーション フィールドは global に設定する必要があります。
   • PROJECT_ID: プロジェクトの ID。

   gcloud observability scopes update コマンドを実行します。

   Linux、macOS、Cloud Shell

   gcloud observability scopes update OBSERVABILITY_SCOPE_ID \
      --log-scope=LOG_SCOPE_FQN_ID\
      --location=LOCATION\
      --project=PROJECT_ID

   Windows（PowerShell）

   gcloud observability scopes update OBSERVABILITY_SCOPE_ID `
      --log-scope=LOG_SCOPE_FQN_ID`
      --location=LOCATION`
      --project=PROJECT_ID

   Windows（cmd.exe）

   gcloud observability scopes update OBSERVABILITY_SCOPE_ID ^
      --log-scope=LOG_SCOPE_FQN_ID^
      --location=LOCATION^
      --project=PROJECT_ID

   たとえば、LOG_SCOPE_ID の値が my-scope の場合、レスポンスは次のようになります。

   Updated scope [_Default].
   logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/my-scope
   name: projects/my-project/locations/global/scopes/_Default
   

Terraform

Terraform を使用してログスコープの作成と変更を行うことができます。ただし、Terraform を使用してデフォルトのログスコープを設定することはできません。

REST

Observability API を使用してデフォルトのログスコープを取得または設定する手順は次のとおりです。

1. Observability API が有効になっていることを確認します。

   1. After installing the Google Cloud CLI, initialize it by running the following command:

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

   2. Google Cloud CLI のデフォルト プロジェクトを設定します。

      gcloud config set project PROJECT_ID
      

      前述のコマンドを実行する前に、次のように置き換えます。

      • PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

   3. Enable the Observability API:

      gcloud services enable observability.googleapis.com

2. 次のいずれかを行います。

   • プロジェクトのデフォルトのログスコープを取得するには、projects.locations.scopes.get エンドポイントにリクエストを送信します。パスパラメータを指定する必要があります。レスポンスは、デフォルトのログスコープを一覧表示する Scope オブジェクトです。

   • プロジェクトのデフォルトのログスコープを更新するには、projects.locations.scopes.patch エンドポイントにリクエストを送信します。パスパラメータとクエリ パラメータを指定し、Scope オブジェクトを指定する必要があります。クエリ パラメータは、変更されるフィールドを特定します。レスポンスは Scope オブジェクトです。

     どちらのエンドポイントのパスパラメータも次の形式になります。

     projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID
     

     前の式のフィールドの意味は次のとおりです。

     • PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
     • LOCATION: ロケーション フィールドは global に設定する必要があります。
     • OBSERVABILITY_SCOPE_ID: Scope オブジェクトの名前。このフィールドは _Default に設定する必要があります。_Default という名前の Scope オブジェクトに、デフォルトのログスコープに関する情報が格納されます。このオブジェクトは自動的に作成されます。

   API エンドポイントにコマンドを送信するには、API Explorer を使用します。API Explorer を使用すると、リファレンス ページからコマンドを実行できます。たとえば、現在のデフォルト スコープを取得するには、次の操作を行います。

   1. projects.locations.scopes.get をクリックします。

   2. [この方法を試す] ウィジェットの [名前] フィールドに、次のように入力します。

      projects/PROJECT_ID/locations/global/scopes/_Default
      

      前のフィールドをコピーする前に、PROJECT_ID をプロジェクトの名前に置き換えます。

   3. [Execute] を選択します。

   4. 承認ダイアログで、必要な手順を完了します。

      レスポンスは次の例のようになります。

      {
      "name": "projects/my-project/locations/global/scopes/_Default",
      "logScope": "logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default"
      }
      

コンソール

ログスコープを作成するには、次の操作を行います。

1. Google Cloud コンソールで [settings 設定] ページに移動します。

   [設定] に移動

   このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

2. Google Cloud コンソールのツールバーで、プロジェクト、フォルダ、または組織を選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
3. [ログスコープ] タブを選択してから、[ログスコープを作成] をクリックします。

4. プロジェクトを追加するには、[プロジェクトを追加] をクリックしてダイアログを完了します。

   プロジェクトを追加すると、そのプロジェクトに対する IAM ロールにより、表示できるログエントリが決まります。たとえば、付与されている IAM ロールによっては、ログバケットの特定のログビューからアクセス可能なログエントリのみが表示される場合があります。ロールの詳細については、Logging のロールをご覧ください。

5. ログビューを追加するには、[ログビューを追加] をクリックしてダイアログを完了します。

   ダイアログには、現在のプロジェクトから発生したログエントリ、または別のプロジェクトのシンクによって現在のプロジェクトに転送されたログエントリを含むすべてのログビューが一覧表示されます。たとえば、シンクを構成していない場合、このダイアログには現在のプロジェクトのログビューが表示されます。

   別の Google Cloud プロジェクトに保存されているログビューを一覧表示するには、[add_circle プロジェクトをインポート] をクリックしてから、 Google Cloud プロジェクトを選択します。

   ログビューを追加すると、ログビューまたはログビューを保存するプロジェクトに対する IAM ロールによって、アクセスできるログエントリが決まります。詳細については、ログビューへのアクセスを制御するをご覧ください。

6. [ログのスコープの指定] セクションで、[ログスコープ] タブに表示する名前と説明を入力します。

   ログスコープの名前は変更できません。また、プロジェクト内で一意にする必要があります。

7. [ログスコープを作成] をクリックします。

gcloud

プロジェクトにログスコープを作成するには、gcloud logging scopes create コマンドを使用します。

 gcloud logging scopes create LOG_SCOPE_ID --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

コマンドを実行する前に、次のフィールドを更新します。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOG_SCOPE_ID: ログスコープの ID。例: my-scope

• DESCRIPTION: 省略可。ログスコープの説明。説明を文字列としてフォーマットします。

• RESOURCE_NAMES: プロジェクトまたはログビューの完全修飾名のカンマ区切りのリスト。たとえば、ログスコープに my-project を含めるには、projects/my-project を指定します。

Terraform

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。詳細については、Terraform プロバイダのリファレンス ドキュメントをご覧ください。

Terraform を使用してプロジェクト、フォルダ、組織にログスコープを作成するには、Terraform リソース google_logging_log_scope を使用します。

コマンドで、次のフィールドを設定します。

• parent: プロジェクト、フォルダ、または組織の完全修飾名。たとえば、このフィールドを "projects/PROJECT_ID" に設定します。ここで、PROJECT_ID は Google Cloud プロジェクトの ID です。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• locations: "global" に設定します。

• name: ログスコープの完全修飾名に設定します。プロジェクトの場合、このフィールドの形式は次のとおりです。

  "projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE_ID"
  

  上記の式で、LOG_SCOPE_ID はログスコープの名前（production など）です。

• resource_names: プロジェクトとログビューの配列。各プロジェクトとログビューは完全修飾名で指定します。

• description: 簡単な説明。たとえば、「本番環境リソースのスコープ」などです。

REST

Cloud Logging API は、フォルダまたは組織でのログスコープの作成もサポートしています。詳しくは、API リファレンス ドキュメントをご覧ください。

Google Cloud プロジェクトの場合は、次のコマンドを使用します。

• projects.locations.logScopes.create

上記のコマンドの parent フィールドの構文は次のとおりです。

projects/PROJECT_ID/locations/LOCATION_ID

前の式のフィールドの意味は次のとおりです。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOCATION_ID は global に設定する必要があります。

コンソール

自分または同僚が作成したログスコープを変更または削除するには、次の操作を行います。

1. Google Cloud コンソールで [settings 設定] ページに移動します。

   [設定] に移動

   このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

2. Google Cloud コンソールのツールバーで、プロジェクト、フォルダ、または組織を選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
3. [ログスコープ] タブを選択します。

4. 変更または削除するログスコープを見つけて、[more_vert その他] をクリックしてから、次のいずれかを行います。

   • 変更するには、[スコープの編集] を選択して、ダイアログを完了します。
   • 削除するには、[スコープの削除] を選択して、ダイアログを完了します。

gcloud

プロジェクトのログスコープに含まれるリソースのリストの説明を変更するには、gcloud logging scopes update コマンドを使用します。

 gcloud logging scopes update LOG_SCOPE_ID --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

コマンドを実行する前に、次のフィールドを更新します。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOG_SCOPE_ID: ログスコープの ID。例: my-scope

• DESCRIPTION: ログスコープの説明。説明を文字列としてフォーマットします。ログスコープの説明を変更しない場合は、このフィールドを省略します。

• RESOURCE_NAMES: プロジェクトまたはログビューの完全修飾名のカンマ区切りのリスト。リソースのリストを変更しない場合は、このフィールドを省略します。

プロジェクトのログスコープを削除するには、gcloud logging scopes delete コマンドを使用します。

 gcloud logging scopes delete LOG_SCOPE_ID --project=PROJECT_ID

コマンドを実行する前に、次のフィールドを更新します。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOG_SCOPE_ID: ログスコープの ID。例: my-scope

Terraform

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。詳細については、Terraform プロバイダのリファレンス ドキュメントをご覧ください。

Terraform を使用してプロジェクト、フォルダ、組織にログスコープを変更するには、Terraform リソース google_logging_log_scope を使用します。

REST

Cloud Logging API には、ログスコープを変更または削除できるコマンドがあります。コマンドの一覧については、API リファレンス ドキュメントをご覧ください。

Google Cloud プロジェクトの場合は、次のコマンドを使用します。

• projects.locations.logScopes.patch
• projects.locations.logScopes.delete

上記のコマンドの parent フィールドの構文は次のとおりです。

projects/PROJECT_ID/locations/LOCATION_ID/logScopes/LOG_SCOPE_ID

前の式のフィールドの意味は次のとおりです。

• PROJECT_ID: プロジェクトの ID。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
• LOCATION_ID は global に設定する必要があります。
• LOG_SCOPE_ID: ログスコープの ID。例: my-scope