Mengelola bucket observabilitas

Dokumen ini menjelaskan cara menggunakan Observability API untuk mendapatkan informasi tentang bucket kemampuan pengamatan Anda. Selain itu, terdapat juga informasi tentang cara mencantumkan set data, link, dan tampilan. Untuk mempelajari lebih lanjut cara Google Cloud Observability menyimpan data, lihat Ringkasan penyimpanan.

Data rekaman aktivitas Anda disimpan dalam bucket pengamatan. Dokumen ini menjelaskan cara mengelola penyimpanan data rekaman aktivitas, tetapi tidak menjelaskan format data yang disimpan. Untuk mengetahui informasi tentang topik tersebut, lihat Skema rekaman aktivitas.

Dokumen ini tidak berlaku untuk penyimpanan data log atau metrik. Data log dan metrik tidak disimpan di bucket kemampuan observasi.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

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 API

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

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

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 API

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 tab untuk melihat bagaimana Anda berencana menggunakan contoh di halaman ini:
gcloud

Di konsol Google Cloud , aktifkan Cloud Shell.

Aktifkan Cloud Shell

Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.
REST

Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.
Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi Google Cloud .

Mencantumkan bucket kemampuan observasi

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 kemampuan pengamatan yang ada di project Anda dan di lokasi tertentu, kirim permintaan ke endpoint 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

Misalnya, saat perintah dikeluarkan ke endpoint buckets.list dengan parameter induk ditetapkan ke projects/my-project/locations/us, responsnya adalah:

{
  "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 mengeluarkan perintah ke endpoint Observability API lainnya 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 daftar lengkap endpoint Observability API, lihat dokumentasi referensi Observability API.

Mencantumkan set data di bucket pengamatan

gcloud

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

BUCKET_ID: ID bucket kemampuan observasi. 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, kirim permintaan ke endpoint 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 observasi. 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/dataset/DATASET_ID

Misalnya, saat perintah dikeluarkan ke endpoint buckets.datasets.list dengan parameter induk ditetapkan ke projects/my-project/locations/us/buckets/_Trace, responsnya adalah:

{
  "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 mengeluarkan perintah ke endpoint Observability API lainnya untuk mendapatkan informasi tentang set data yang ID-nya adalah DATASET_ID. Misalnya, Anda dapat mencantumkan tampilan dan link di setiap set data. Untuk daftar lengkap endpoint Observability API, lihat dokumentasi referensi Observability API.

Mencantumkan tampilan pada 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 observasi. 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 kemampuan pengamatan. 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 membuat daftar tampilan pada set data, kirim permintaan ke endpoint 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 observasi. 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/views/OBS_VIEW_ID

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

Misalnya, saat perintah dikeluarkan ke endpoint buckets.datasets.views.list dengan parameter induk ditetapkan ke projects/my-project/locations/us/buckets/_Trace/datasets/Spans/views, responsnya adalah:

{
  "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 daftar lengkap endpoint Observability API, lihat dokumentasi referensi Observability API.

Mencantumkan link pada 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 observasi. 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, kirim permintaan ke endpoint 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 observasi. 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/links/LINK_ID

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

Misalnya, saat perintah dikeluarkan ke endpoint buckets.datasets.links.list dengan parameter induk ditetapkan ke projects/my-project/locations/us/buckets/_Trace/datasets/Spans/links, responsnya adalah:

{
  "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 daftar lengkap endpoint Observability API, lihat dokumentasi referensi Observability API.

Membuat link pada set data

Anda dapat membuat link pada set data, yang memungkinkan data rekaman aktivitas Anda dikueri dari BigQuery. Anda juga dapat menghapus objek Link yang terlampir pada set data.

Sebelum memulai

Selesaikan penyiapan yang diperlukan untuk mencantumkan link.
Untuk mendapatkan izin yang Anda perlukan untuk membuat link pada set data, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:
- Editor Kemampuan Observasi (roles/observability.editor)
- Pengguna BigQuery (roles/bigquery.user)
Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

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

Membuat set data BigQuery tertaut

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 observasi. 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 observasi. 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 dan 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/dataset/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 akan berisi data status.

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

Langkah berikutnya

Untuk mempelajari cara membuat kueri telemetri, lihat Melihat dan menganalisis telemetri.

Mengelola bucket observabilitas Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Sebelum memulai

gcloud

REST

Mencantumkan bucket kemampuan observasi

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

Mencantumkan set data di bucket pengamatan

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

Mencantumkan tampilan pada set data

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

Mencantumkan link pada set data

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

Membuat link pada set data

Sebelum memulai

Membuat set data BigQuery tertaut

gcloud

Linux, macOS, atau Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

Langkah berikutnya

Mengelola bucket observabilitas