オブザーバビリティ バケットを作成する

プロジェクトがトレースデータを受信する前に _Trace オブザーバビリティ バケットを手動で作成して、ストレージの場所と顧客管理の暗号鍵(CMEK)の設定をカスタマイズできます。このバケットが存在する前に Google Cloud プロジェクトがトレースデータを取り込むと、Google Cloud Observability は、プロジェクトのオブザーバビリティ バケットのデフォルト設定を使用してバケットを自動的にプロビジョニングします。

Google Cloud Observability によるデータの保存方法については、ストレージの概要をご覧ください。

組織のポリシーとの相互作用

オブザーバビリティ バケットの作成リクエストは、コマンド パラメータが組織のポリシーに準拠していることを確認します。たとえば、組織のポリシーでリソース ロケーションが制限されている場合、制限されたロケーションを指定すると、バケットの作成は失敗します。

オブザーバビリティ バケットのデフォルト設定との相互作用

Google Cloud Observability がデータの取り込みによりオブザーバビリティ バケットを自動的に作成する場合、バケットの親リソースに適用されるオブザーバビリティ バケットのデフォルト設定が使用されます。これらのデフォルト設定は、親または親の階層祖先で定義されている可能性があり、次の内容を指定します。

  • ストレージの場所。
  • 保存されたデータに使用する Cloud KMS 鍵。

オブザーバビリティ バケットを作成するときは、ロケーションを指定する必要があります。作成リクエストで別の鍵を明示的に指定しない限り、Google Cloud Observability はデフォルト設定で定義された Cloud KMS 鍵を適用します。

該当するデフォルト設定で Cloud KMS 鍵が指定されている場合、Google のデフォルトの暗号化でバケットを作成することはできません。Google のデフォルトの暗号化を使用するには、デフォルト設定で Cloud KMS 鍵が構成されていないことを確認します。

オブザーバビリティ バケットのデフォルト設定については、オブザーバビリティ バケットのデフォルトを設定するをご覧ください。

制限事項

次の制限が適用されます。

  • サポートされているロケーションを指定する必要があります。
  • BUCKET_ID_Trace とする必要があります。
  • 表示名は 100 エンコード バイトを超えてはなりません。
  • 説明は 1,000 バイトのエンコードされたバイトを超えてはなりません。
  • データは 30 日間保存されます。保持期間を省略するか、30 に設定する必要があります。
  • Cloud KMS 鍵を指定する場合、鍵のロケーションはオブザーバビリティ バケットの親ロケーションと完全に一致する必要があります。
  • オブザーバビリティ バケットは Google Cloud プロジェクトでのみ作成できます。
  • Google Cloud プロジェクトに設定できるオブザーバビリティ バケットは、_Trace という名前のバケット 1 つまでです。

始める前に

プロジェクトと IAM ロールを構成し、使用するインターフェースを選択します。

プロジェクトとロールを構成する

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

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  5. 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

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  8. オブザーバビリティ バケットの作成に必要な権限を取得するには、プロジェクトに対するオブザーバビリティ編集者 roles/observability.editor)IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

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

インターフェースを構成する

gcloud

Google Cloud コンソールで Cloud Shell をアクティブにします。

Cloud Shell をアクティブにする

Google Cloud コンソールの下部にある Cloud Shell セッションが開始し、コマンドライン プロンプトが表示されます。Cloud Shell はシェル環境です。Google Cloud CLI がすでにインストールされており、現在のプロジェクトの値もすでに設定されています。セッションが初期化されるまで数秒かかることがあります。

REST

このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

    Google Cloud CLI をインストールします。

    外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

Cloud KMS 鍵を構成する

省略可。オブザーバビリティ バケットを作成して Cloud KMS 鍵を指定する場合は、次の操作を行います。

  1. Cloud Key Management Service API を有効にします。

    API を有効にするために必要なロール

    API を有効にするには、serviceusage.services.enable 権限が必要です。プロジェクトを作成した場合は、オーナーロール(roles/owner)を介してこの権限がすでに付与されている可能性があります。それ以外の場合は、Service Usage 管理者ロール(roles/serviceusage.serviceUsageAdmin)を介してこの権限を取得できます。ロールを付与する方法をご覧ください。

    API の有効化

  2. キーリングと鍵を作成します。

    オブザーバビリティ バケットのロケーションは、鍵のロケーションと一致している必要があります。

  3. PROJECT_ID をプロジェクトの ID に置き換えて、次のコマンドを実行します。

    gcloud beta observability settings describe \
    --location=global --project=PROJECT_ID
    

    上記のコマンドは、デフォルトの保存場所が構成されているかどうかを確認します。また、Google Cloud Observability サービス アカウントが存在しない場合は、そのアカウントも作成します。コマンドのレスポンスには、サービス アカウントの ID が一覧表示されます。

  4. Google Cloud Observability サービス アカウントに Cloud KMS CryptoKey の暗号化/復号ロールを付与します。

    gcloud kms keys add-iam-policy-binding \
    --project=KMS_PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-observability.iam.gserviceaccount.com \
    --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
    --location=KMS_KEY_LOCATION \
    --keyring=KMS_KEY_RING \
    KMS_KEY_NAME
    

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

    • KMS_PROJECT_ID: Cloud KMS を実行している Google Cloud プロジェクトの一意の英数字の ID で、 Google Cloud プロジェクト名とランダムに割り当てられた番号で構成されます。この ID を取得する方法については、プロジェクトの識別をご覧ください。
    • service-PROJECT_NUMBER: 前の手順のレスポンスに表示されたオブザーバビリティ サービス アカウントの名前。
    • KMS_KEY_LOCATION: Cloud KMS 鍵のリージョン。
    • KMS_KEY_RING: Cloud KMS キーリングの名前。
    • KMS_KEY_NAME: Cloud KMS 鍵の名前。次のような形式になります。projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KMS_KEY_RING/cryptoKeys/KEY

オブザーバビリティ バケットを作成する

REST

オブザーバビリティ バケットを作成するには、projects.locations.buckets.create にリクエストを送信します。

次の形式の親パラメータを指定する必要があります。

projects/PROJECT_ID/locations/LOCATION

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

リクエスト本文は Bucket オブジェクトです。次のフィールドに値を入力します。

  • name: このフィールドを次のように設定します。

    projects/PROJECT_ID/locations/LOCATION/buckets/_Trace
    
  • 省略可: displayName フィールドと description フィールドに値を指定します。

  • 省略可: CMEK を指定します。指定すると、この鍵は保存されたデータを暗号化します。

    CMEK を指定しない場合、バケットの親リソースに適用されるデフォルト設定によって暗号鍵が決まります。デフォルト設定で Cloud KMS 鍵が指定されている場合、その鍵によって保存データが暗号化されます。それ以外の場合は、Google のデフォルトの暗号化が使用されます。

レスポンスは Operation オブジェクトです。Operation.done フィールドが true に設定されるまで、projects.locations.operations.get メソッドをポーリングします。Operation 構造の他のフィールドには、リクエストの成功または失敗に関する情報が格納されます。

オブザーバビリティ バケットを一覧表示する

オブザーバビリティ バケットを一覧表示して、作成リクエストが正常に完了したことを確認できます。

gcloud

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

  • LOCATION: オブザーバビリティ バケットのロケーション。ロケーションに関係なくすべてのオブザーバビリティ バケットを一覧表示するには、ロケーションをハイフン(-)に設定します。
  • PROJECT_ID: プロジェクトの ID。

gcloud beta observability buckets list コマンドを実行します。

Linux、macOS、Cloud Shell

gcloud beta observability buckets list \
 --location=LOCATION --project=PROJECT_ID

Windows(PowerShell)

gcloud beta observability buckets list `
 --location=LOCATION --project=PROJECT_ID

Windows(cmd.exe)

gcloud beta observability buckets list ^
 --location=LOCATION --project=PROJECT_ID

レスポンスには、各オブザーバビリティ バケットの名前、説明、作成時間が一覧表示されます。コマンドが成功した場合のレスポンスの例を次に示します。

---
createTime: '2026-01-21T21:39:22.381083860Z'
description: Bucket for storing spans from Cloud Trace.
name: projects/my-project/locations/us/buckets/_Trace

REST

プロジェクトと特定のロケーションにあるオブザーバビリティ バケットを一覧表示するには、projects.locations.buckets.list エンドポイントにリクエストを送信します。

次の形式の親パラメータを指定する必要があります。

projects/PROJECT_ID/locations/LOCATION

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

レスポンスは Bucket オブジェクトの配列です。各オブジェクトの name フィールドの値の形式は次のとおりです。

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID

たとえば、親パラメータが projects/my-project/locations/us に設定された buckets.list エンドポイントにコマンドが発行された場合、レスポンスは次のようになります。

{
  "buckets": [
    {
      "name": "projects/my-project/locations/us/buckets/_Trace",
      "description": "Trace Bucket",
      "createTime": "2025-01-01T15:42:30.988919645Z",
      "updateTime": "2025-02-04T15:42:30.988919645Z",
      "retentionDays": 30
    }
  ]
}

他の Observability API エンドポイントにコマンドを発行して、ID が BUCKET_ID のバケットに関する詳細情報を取得できます。たとえば、そのバケットのデータセット、各データセットのビューとリンクを一覧表示できます。Observability API エンドポイントの一覧については、Observability API リファレンス ドキュメントをご覧ください。

次のステップ