Mengelola bucket observabilitas

Pratinjau

Produk atau fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dari Persyaratan Khusus Layanan. Produk dan fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

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.
Instal Google Cloud CLI.
Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.
Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:
gcloud init
Buat atau pilih Google Cloud project.
Peran yang diperlukan untuk memilih atau membuat project
• Pilih project: Memilih project tidak memerlukan peran IAM tertentu—Anda dapat memilih project mana pun yang telah diberi peran.
• Membuat project: Untuk membuat project, Anda memerlukan peran Pembuat Project (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.
Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.
• Buat Google Cloud project:

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih project Google Cloud yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama project Google Cloud Anda.
Verifikasi bahwa penagihan diaktifkan untuk project Google Cloud Anda.
Aktifkan Observability API:
Peran yang diperlukan untuk mengaktifkan API
Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.
gcloud services enable observability.googleapis.com
Memberikan peran ke akun pengguna Anda. Jalankan perintah berikut satu kali untuk setiap peran IAM berikut: roles/observability.viewer
gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE
Ganti kode berikut:
• PROJECT_ID: Project ID Anda.
• USER_IDENTIFIER: ID untuk akun pengguna Anda. Misalnya, [e-mail].
• ROLE: Peran IAM yang Anda berikan ke akun pengguna Anda.

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Buat atau pilih Google Cloud project.

Peran yang diperlukan untuk memilih atau membuat project

• Pilih project: Memilih project tidak memerlukan peran IAM tertentu—Anda dapat memilih project mana pun yang telah diberi peran.
• Membuat project: Untuk membuat project, Anda memerlukan peran Pembuat Project (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

• Buat Google Cloud project:

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih project Google Cloud yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama project Google Cloud Anda.

Verifikasi bahwa penagihan diaktifkan untuk project Google Cloud Anda.

Aktifkan Observability API:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

gcloud services enable observability.googleapis.com

Memberikan peran ke akun pengguna Anda. Jalankan perintah berikut satu kali untuk setiap peran IAM berikut: roles/observability.viewer

gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE

Ganti kode berikut:

• PROJECT_ID: Project ID Anda.
• USER_IDENTIFIER: ID untuk akun pengguna Anda. Misalnya, [e-mail].
• ROLE: Peran IAM yang Anda berikan ke akun pengguna Anda.

Mencantumkan bucket kemampuan observasi

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

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

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

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

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

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