Mencantumkan bucket rekaman aktivitas dan mengelola set data

Anda dapat menggunakan Observability API atau Google Cloud CLI untuk melihat bucket observabilitas, memeriksa set data dan tampilan, serta membuat link untuk menganalisis data rekaman aktivitas yang disimpan dengan SQL.

Untuk mengetahui latar belakang konseptual dan detail penyimpanan, lihat Ringkasan penyimpanan rekaman aktivitas dan Skema rekaman aktivitas.

Sebelum memulai

Konfigurasi project dan peran Identity and Access Management (IAM), lalu pilih antarmuka yang akan Anda gunakan.

Mengonfigurasi project dan peran Anda

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

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

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

  4. Untuk mendapatkan izin yang diperlukan guna membuat daftar bucket, link, dan tampilan, minta administrator untuk memberi Anda peran IAM Observability Viewer (roles/observability.viewer) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Pilih antarmuka yang akan Anda gunakan

gcloud

Instal Google Cloud CLI, lalu login ke gcloud CLI dengan identitas gabungan Anda. Setelah login, inisialisasi Google Cloud CLI dengan menjalankan perintah berikut:

gcloud init

REST

Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.

    Instal Google Cloud CLI, lalu login ke gcloud CLI dengan identitas gabungan Anda.

Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi Google Cloud .

Mencantumkan bucket kemampuan observasi

Bagian ini menjelaskan cara mencantumkan bucket kemampuan pengamatan Anda. Bucket kemampuan pengamatan adalah entitas pengelolaan untuk set data, yang menyimpan data.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • LOCATION: Lokasi bucket pengamatan. Untuk mencantumkan semua bucket kemampuan pengamatan, terlepas dari lokasi, tetapkan lokasi ke tanda hubung (-).
  • PROJECT_ID: ID project.

Jalankan perintah gcloud beta observability buckets list:

Linux, macOS, atau 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

Respons mencantumkan nama, deskripsi, dan waktu pembuatan setiap bucket pengamatan. Berikut adalah contoh respons saat perintah berhasil:

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

REST

Untuk mencantumkan bucket pengamatan yang ada di project Anda dan di lokasi tertentu, gunakan metode projects.locations.buckets.list.

Anda harus menentukan parameter induk, yang memiliki bentuk berikut:

projects/PROJECT_ID/locations/LOCATION

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project.
  • LOCATION: Lokasi bucket pengamatan. Jika Anda menetapkan LOCATION ke tanda hubung, (-), semua bucket kemampuan pengamatan di project Anda akan dicantumkan.

Responsnya adalah array objek Bucket. Untuk setiap objek, nilai kolom name memiliki format berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID

Berikut adalah contoh respons:

{
  "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
    }
  ]
}

Anda dapat menggunakan Observability API untuk mendapatkan informasi selengkapnya tentang bucket yang ID-nya adalah BUCKET_ID. Misalnya, Anda dapat mencantumkan set data di bucket tersebut, serta tampilan dan link di setiap set data. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Observability API.

Mencantumkan set data di bucket pengamatan

Bagian ini menjelaskan cara mencantumkan set data kemampuan pengamatan di bucket kemampuan pengamatan. Bucket observabilitas adalah container pengelolaan untuk set data, yang menyimpan data. Saat membuat bucket, Google Cloud Observability akan otomatis membuat set data.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • LOCATION: Lokasi bucket pengamatan.
  • PROJECT_ID: ID project.

Jalankan perintah gcloud beta observability buckets datasets list:

Linux, macOS, atau Cloud Shell

gcloud beta observability buckets datasets list \
 --bucket=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID \
 --location=LOCATION \
 --project=PROJECT_ID

Windows (PowerShell)

gcloud beta observability buckets datasets list `
 --bucket=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID `
 --location=LOCATION `
 --project=PROJECT_ID

Windows (cmd.exe)

gcloud beta observability buckets datasets list ^
 --bucket=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID ^
 --location=LOCATION ^
 --project=PROJECT_ID

Respons mencantumkan nama, deskripsi, dan waktu pembuatan setiap set data. Berikut adalah contoh respons saat perintah berhasil:

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

REST

Untuk mencantumkan set data untuk bucket kemampuan pengamatan, gunakan metode projects.locations.buckets.datasets.list.

Anda harus menentukan parameter induk, yang memiliki bentuk berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project.
  • LOCATION: Lokasi bucket pengamatan.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.

Responsnya adalah array objek Dataset. Untuk setiap objek, nilai kolom name memiliki format berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID

Berikut adalah contoh respons:

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

Anda dapat menggunakan Observability API untuk mendapatkan informasi tentang set data yang ID-nya adalah DATASET_ID. Misalnya, Anda dapat mencantumkan tampilan dan link di setiap set data. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Observability API.

Mencantumkan tampilan pada set data

Bagian ini menjelaskan cara mencantumkan tampilan kemampuan pengamatan Anda. Setiap set data observabilitas menghosting satu atau beberapa tampilan. Tampilan memberikan akses baca ke subset entri dalam set data. Google Cloud Observability membuat tampilan saat membuat set data. Tampilan tersebut mencakup semua data dalam set data.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • DATASET_ID: ID set data. Data rekaman aktivitas Anda disimpan dalam set data bernama Spans.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • LOCATION: Lokasi bucket pengamatan.
  • PROJECT_ID: ID project.

Jalankan perintah gcloud beta observability buckets datasets views list:

Linux, macOS, atau Cloud Shell

gcloud beta observability buckets datasets views list \
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID \
 --bucket=BUCKET_ID \
 --location=LOCATION \
 --project=PROJECT_ID

Windows (PowerShell)

gcloud beta observability buckets datasets views list `
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID `
 --bucket=BUCKET_ID `
 --location=LOCATION `
 --project=PROJECT_ID

Windows (cmd.exe)

gcloud beta observability buckets datasets views list ^
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID ^
 --bucket=BUCKET_ID ^
 --location=LOCATION ^
 --project=PROJECT_ID

Respons mencantumkan nama, waktu pembuatan, dan waktu pembaruan setiap tampilan observasi. Berikut adalah contoh respons saat perintah berhasil:

---
createTime: '2026-01-21T21:39:22.381083860Z'
displayName: _AllSpans
name: projects/pamstestproject1/locations/us/buckets/_Trace/datasets/Spans/views/_AllSpans
updateTime: '2026-01-21T21:39:22.381083860Z'

REST

Untuk mencantumkan tampilan pada set data, gunakan metode projects.locations.buckets.datasets.views.list.

Anda harus menentukan parameter induk, yang memiliki bentuk berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/views

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project.
  • LOCATION: Lokasi bucket pengamatan.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • DATASET_ID: ID set data yang dikueri. Misalnya, ID ini mungkin Spans.

Responsnya adalah array objek View. Untuk setiap objek, nilai kolom name memiliki format berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/views/OBS_VIEW_ID

Dalam ekspresi sebelumnya, ID tampilan diwakili oleh OBS_VIEW_ID. Misalnya, kolom ini mungkin memiliki nilai _AllSpans.

Berikut adalah contoh respons:

{
  "views": [
    {
      "name": "projects/my-project/locations/us/buckets/_Trace/datasets/Spans/views/_AllSpans",
      "filter": "",
      "createTime": "2025-01-01T15:42:30.988919645Z",
      "updateTime": "2025-02-04T15:42:30.988919645Z",
    }
  ]
}

Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Observability API.

Bagian ini menjelaskan cara mencantumkan link pada set data kemampuan pengamatan Anda. Penautan dapat memungkinkan Anda membuat kueri data menggunakan layanan BigQuery atau memungkinkan layanan Google Cloud membuat kueri subset data tersebut.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • DATASET_ID: ID set data. Data rekaman aktivitas Anda disimpan dalam set data bernama Spans.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • LOCATION: Lokasi bucket pengamatan.
  • PROJECT_ID: ID project.

Jalankan perintah gcloud beta observability buckets datasets links list:

Linux, macOS, atau Cloud Shell

gcloud beta observability buckets datasets links list \
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID\
 --bucket=BUCKET_ID \
 --location=LOCATION \
 --project=PROJECT_ID

Windows (PowerShell)

gcloud beta observability buckets datasets links list `
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID`
 --bucket=BUCKET_ID `
 --location=LOCATION `
 --project=PROJECT_ID

Windows (cmd.exe)

gcloud beta observability buckets datasets links list ^
 --dataset=projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID^
 --bucket=BUCKET_ID ^
 --location=LOCATION ^
 --project=PROJECT_ID

Respons mencantumkan nama dan waktu pembuatan setiap link. Berikut adalah contoh respons saat perintah berhasil:

---
createTime: '2026-04-02T21:23:09.272323714Z'
name: projects/my-project/locations/us/buckets/_Trace/datasets/Spans/links/mydataset

REST

Untuk mencantumkan link pada set data, gunakan metode projects.locations.buckets.datasets.links.list.

Anda harus menentukan parameter induk, yang memiliki bentuk berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project.
  • LOCATION: Lokasi bucket pengamatan.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • DATASET_ID: ID set data yang dikueri. Misalnya, ID ini mungkin Spans.

Responsnya adalah array objek Link. Untuk setiap objek, nilai kolom name memiliki format berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/links/LINK_ID

LINK_ID adalah nama set data BigQuery. Kolom ini bersifat unik secara global untuk project Google Cloud Anda.

Berikut adalah contoh respons:

{
  "links": [
    {
      "name": "projects/my-project/locations/us/buckets/_Trace/datasets/Spans/links/my_link",
      "description": "My link for traces to BigQuery",
      "createTime": "2025-01-12T15:42:30.988919645Z"
    }
  ]
}

Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Observability API.

Bagian ini menjelaskan cara membuat set data BigQuery tertaut pada set data observabilitas, yang memungkinkan Anda menggunakan layanan BigQuery untuk membuat kueri data rekaman aktivitas. Setiap set data observasi mendukung satu set data BigQuery tertaut.

Saat Anda membuat link pada set data observasi, hal berikut akan terjadi:

  • Google Cloud Observability dapat membuat akun layanan berikut atau mengubah pemberian peran IAM-nya:

  • Log audit mencatat permintaan untuk membuat penautan dan permintaan dari pengelola agen layanan untuk memberikan peran IAM Agen Layanan Monitoring kepada Akun Layanan Monitoring. Log ini juga mencatat penyelesaian operasi yang berjalan lama.

Sebelum memulai

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

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

  3. Enable the Cloud Monitoring and Observability APIs.

    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 APIs

  4. Untuk mendapatkan izin yang diperlukan guna membuat link pada dataset kemampuan pengamatan, minta administrator untuk memberi Anda peran IAM Observability Editor (roles/observability.editor) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

  • LINK_ID: Nama set data BigQuery.
  • DATASET_ID: ID set data. Data rekaman aktivitas Anda disimpan dalam set data bernama Spans.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • LOCATION: Lokasi bucket pengamatan.
  • PROJECT_ID: ID project.

Jalankan perintah gcloud beta observability buckets datasets links create:

Linux, macOS, atau Cloud Shell

gcloud beta observability buckets datasets links create \
  projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/links/LINK_ID \
 --dataset=DATASET_ID\
 --bucket=BUCKET_ID \
 --location=LOCATION \
 --project=PROJECT_ID

Windows (PowerShell)

gcloud beta observability buckets datasets links create `
  projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/links/LINK_ID `
 --dataset=DATASET_ID`
 --bucket=BUCKET_ID `
 --location=LOCATION `
 --project=PROJECT_ID

Windows (cmd.exe)

gcloud beta observability buckets datasets links create ^
  projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/links/LINK_ID ^
 --dataset=DATASET_ID^
 --bucket=BUCKET_ID ^
 --location=LOCATION ^
 --project=PROJECT_ID

Perintah create memulai operasi yang berjalan lama. Berikut adalah contoh respons saat perintah berhasil:

Create request issued for: [mydataset]
Waiting for operation [projects/my-project/locations/us/operations/operation-1775164903749-64e80c9817833-9ff804b6-c3e9cbe7] to complete...done.
Created link [mydataset].

REST

Untuk membuat link ke set data BigQuery, kirim permintaan ke endpoint projects.locations.buckets.datasets.links.create.

Anda harus menentukan parameter induk, yang memiliki bentuk berikut:

projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project.
  • LOCATION: Lokasi bucket pengamatan.
  • BUCKET_ID: ID bucket kemampuan pengamatan. Misalnya, ID ini mungkin _Trace.
  • DATASET_ID: ID set data yang dikueri. Misalnya, ID ini mungkin Spans.

Perintah ini memerlukan parameter kueri dan isi permintaan:

  • Parameter kueri, linkId, harus ditentukan dan disetel ke nama set data BigQuery. Contoh, linkId="my_link". Nama set data BigQuery harus unik untuk project Google Cloud Anda, dan harus dibatasi hingga 100 karakter serta hanya boleh menyertakan huruf, angka, dan garis bawah.

  • Isi permintaan adalah objek Link. Nilai kolom name memiliki format berikut:

    projects/PROJECT_ID/locations/LOCATION/buckets/BUCKET_ID/datasets/DATASET_ID/links/LINK_ID
    

    Nilai yang Anda berikan untuk kolom name harus cocok dengan set data BigQuery tertaut yang dirujuk oleh parameter kueri.

    Kolom LINK_ID adalah nama set data BigQuery.

Responsnya adalah objek Operation. Objek ini berisi informasi tentang progres metode. Setelah metode selesai, objek Operation berisi data status.

Untuk mengetahui daftar lengkap endpoint Observability API, lihat dokumentasi referensi Observability API.

Jika Anda mengalami error izin saat membuat set data tertaut, lihat Memecahkan masalah error izin.

Langkah berikutnya