Memperbarui bucket observabilitas

Anda dapat memperbarui nama tampilan, deskripsi, atau kunci Cloud Key Management Service dari bucket kemampuan pengamatan untuk mencerminkan perubahan organisasi atau merotasi kunci enkripsi.

Anda tidak dapat menggunakan operasi update ini untuk menyelesaikan masalah kepatuhan. Misalnya, Anda tidak dapat menggunakan operasi ini untuk mengubah lokasi bucket pengamatan atau menerapkan kunci Cloud KMS ke bucket yang menggunakan enkripsi default Google.

Efek memperbarui kunci Cloud KMS

Memperbarui kunci Cloud KMS untuk bucket pengamatan tidak memengaruhi data yang disimpan. Artinya, sebelum update selesai, kunci asli mengenkripsi data baru. Setelah update selesai, kunci yang diperbarui akan mengenkripsi data baru.

Anda dapat terus mengakses dan melihat data tersimpan asalkan kunci Cloud KMS asli tetap diaktifkan dan akun layanan Google Cloud Observability mempertahankan izin pengenkripsi/pendekripsi.

Jika Anda menonaktifkan atau menghancurkan kunci Cloud KMS asli, semua data yang ditulis saat kunci tersebut aktif akan langsung menjadi tidak dapat diakses dan dibaca secara permanen.

Batasan

Berlaku batasan berikut:

  • Anda tidak dapat mengubah lokasi.
  • Anda tidak dapat menerapkan kunci Cloud KMS ke bucket observabilitas yang menggunakan enkripsi default Google.
  • Nama tampilan tidak boleh melebihi 100 byte yang dienkode.
  • Deskripsi tidak boleh melebihi 1.000 byte yang dienkode.
  • Data disimpan selama 30 hari. Anda dapat menghilangkan periode retensi atau menyetelnya ke 30.
  • Jika Anda memperbarui kunci Cloud KMS, lokasi kunci harus sama persis dengan lokasi induk bucket pengamatan.

Sebelum memulai

Konfigurasi project dan peran IAM Anda, lalu pilih antarmuka yang akan Anda gunakan.

Mengonfigurasi project dan peran Anda

  1. 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.
  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. Untuk mendapatkan izin yang diperlukan guna membuat bucket 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.

Mengonfigurasi antarmuka

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.

    Instal Google Cloud CLI.

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

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

Mengonfigurasi kunci Cloud KMS

Opsional. Jika Anda berencana memperbarui kunci Cloud KMS yang digunakan bucket kemampuan pengamatan, lakukan hal berikut:

  1. Aktifkan Cloud Key Management Service API.

    Peran yang diperlukan untuk mengaktifkan API

    Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Admin Penggunaan Layanan (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

    Mengaktifkan API

  2. Buat key ring dan kunci.

    Lokasi bucket pengamatan harus cocok dengan lokasi kunci.

  3. Ganti PROJECT_ID dengan ID project Anda, lalu jalankan perintah berikut:

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

    Respons terhadap perintah sebelumnya mencantumkan ID akun layanan Google Cloud Observability.

  4. Berikan peran Cloud KMS CryptoKey Encrypter/Decrypter ke akun layanan Google Cloud Observability.

    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
    

    Sebelum menjalankan perintah sebelumnya, lakukan penggantian berikut:

    • KMS_PROJECT_ID: ID alfanumerik unik, yang terdiri dari nama project Google Cloud Anda dan nomor yang ditetapkan secara acak, dari project Google Cloud yang menjalankan Cloud KMS. Untuk mengetahui informasi tentang cara mendapatkan ID ini, lihat Mengidentifikasi project.
    • service-PROJECT_NUMBER: Nama akun layanan Google Cloud Observability yang tercantum di langkah sebelumnya.
    • KMS_KEY_LOCATION: Region kunci Cloud KMS.
    • KMS_KEY_RING: Nama key ring Cloud KMS.
    • KMS_KEY_NAME: Nama kunci Cloud KMS. Formatnya seperti ini: projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KMS_KEY_RING/cryptoKeys/KEY.

Memperbarui bucket observasi

REST

Untuk memperbarui bucket pengamatan, kirim permintaan ke projects.locations.buckets.patch.

Anda harus menentukan parameter induk, yang mengidentifikasi bucket yang akan diperbarui. Parameter ini memiliki format 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.

Parameter kueri harus menentukan kolom updateMask, yang mengidentifikasi kolom yang akan diubah. Contoh:

  • Untuk memperbarui deskripsi, gunakan updateMask=description.
  • Untuk memperbarui kunci Cloud KMS dan deskripsi, gunakan updateMask=description,cmekSettings.kmsKey.

Isi permintaan adalah objek Bucket. Anda harus mengisi setiap kolom yang ditentukan oleh mask pembaruan. Jangan isi kolom yang tidak Anda perbarui.

Misalnya, untuk memperbarui hanya kolom description, Anda dapat menggunakan objek Bucket berikut:

{
    "description": "Updated description for my observability bucket."
}

Responsnya adalah objek Operation. Biasanya, metode ini memerlukan waktu kurang dari satu menit untuk diselesaikan.

Biasanya, untuk menentukan apakah metode yang menampilkan objek Operation telah selesai, Anda melakukan polling objek dengan memanggil projects.locations.operations.get hingga kolom Operation.done ditetapkan ke true. Kemudian, Anda dapat menggunakan kolom lain dalam struktur Operation untuk menentukan apakah metode berhasil atau gagal.

Namun, metode patch selesai dengan cepat. Oleh karena itu, alternatifnya adalah menunggu sebentar, lalu memverifikasi pembaruan dengan mencantumkan bucket pengamatan Anda.

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

Langkah berikutnya