Membuat dan mengelola cakupan rekaman aktivitas

Dokumen ini menjelaskan cara membuat dan mengelola cakupan rekaman aktivitas, yang memungkinkan halaman Trace Explorer menemukan rentang rekaman aktivitas yang ingin Anda lihat atau analisis. Jika hanya ingin melihat dan menganalisis rentang yang berasal dari project Google Cloud , Anda tidak perlu mengonfigurasi cakupan rekaman aktivitas. Namun, jika data rekaman aktivitas Anda disimpan di beberapa project, seperti yang mungkin terjadi saat Anda menggunakan arsitektur microservice, Anda perlu melakukan beberapa aktivitas konfigurasi untuk melihat semua rentang dari satu project. Google Cloud

Dokumen ini tidak menjelaskan cara melihat rekaman aktivitas dan rentang. Untuk mengetahui informasi tentang topik tersebut, lihat Menemukan dan menjelajahi rekaman aktivitas.

Fitur ini hanya didukung untuk Google Cloud project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.

Tentang cakupan rekaman aktivitas

Cakupan rekaman aktivitas adalah resource tingkat project yang persisten yang mencantumkan tampilan, yang memberikan akses ke data rekaman aktivitas Anda. Anda dapat mengonfigurasi halaman Trace Explorer untuk menelusuri menurut cakupan rekaman aktivitas, yang berarti halaman tersebut menelusuri tampilan yang tercantum dalam cakupan yang dipilih. Peran Identity and Access Management (IAM) Anda di tampilan yang dicari dan setelan rentang waktu menentukan data yang diambil sistem dari penyimpanan, lalu ditampilkan.

Anda dapat membuat cakupan rekaman aktivitas, serta mengubah dan menghapus cakupan rekaman aktivitas yang Anda buat. Anda ingin membuat cakupan rekaman aktivitas saat memiliki layanan yang menulis data rentang ke beberapa project Google Cloud .

Cakupan rekaman aktivitas mencantumkan tampilan, bukan Google Cloud project. Meskipun Anda memilih project saat mengonfigurasi cakupan rekaman aktivitas, sistem akan menambahkan tampilan rekaman aktivitas default project tersebut ke cakupan. Tampilan rekaman aktivitas default project sesuai dengan tampilan dengan jalur _Trace/Spans/_AllSpans, dengan kolom _Trace, Spans, dan _AllSpans merujuk ke bucket, set data, dan tampilan kemampuan pengamatan. Set data Spans menyimpan data rekaman aktivitas Anda.

Kecuali jika Anda membuka halaman Trace Explorer dengan URL yang menyertakan cakupan rekaman aktivitas atau ID rekaman aktivitas dan rentang, halaman Trace Explorer akan menelusuri tampilan yang tercantum dalam cakupan rekaman aktivitas default untuk data rekaman aktivitas. Saat Anda membuat project, cakupan rekaman aktivitas bernama _Default akan ditetapkan sebagai cakupan rekaman aktivitas default. Namun, Anda dapat memilih cakupan rekaman aktivitas lain untuk digunakan sebagai cakupan rekaman aktivitas default.

Tentang cakupan kemampuan observasi

Cakupan kemampuan pengamatan menentukan cakupan rekaman aktivitas dan cakupan log mana yang akan digunakan saat halaman penjelajah yang sesuai dibuka. Jika Anda tidak mengonfigurasi cakupan kemampuan observasi untuk mencantumkan resource yang menyimpan data Anda, Anda mungkin tidak dapat mengorelasikan data log dan rekaman aktivitas. Untuk mempelajari lebih lanjut, lihat Mengonfigurasi cakupan kemampuan pengamatan untuk kueri multi-project.

Aplikasi App Hub dan cakupan pelacakan

Aplikasi App Hub Anda mungkin menulis data rekaman aktivitas ke beberapa project. Untuk mendapatkan tampilan gabungan data ini, buat cakupan rekaman aktivitas, konfigurasikan untuk mencantumkan tampilan rekaman aktivitas default dari semua project yang menyimpan data rekaman aktivitas, lalu konfigurasikan sebagai cakupan rekaman aktivitas default. Setelah Anda menyelesaikan langkah-langkah tersebut, halaman Trace Explorer akan otomatis menampilkan data yang ditulis oleh aplikasi Anda, meskipun data tersebut disimpan di project yang berbeda.

Buat cakupan rekaman aktivitas kustom dalam project tempat Anda akan melihat data rekaman aktivitas. Project ini adalah project host App Hub atau project pengelolaan Anda. Misalnya, jika nama tampilan folder adalah My Folder, maka nama tampilan project pengelolaan folder adalah My Folder-mp.

Sebelum memulai

  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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  8. Untuk mendapatkan izin yang diperlukan guna membuat dan melihat cakupan rekaman aktivitas, minta administrator untuk memberi Anda peran IAM Observability Scopes Editor (roles/observability.scopesEditor) 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.

    Peran Editor Cakupan Observabilitas mencakup izin pribadi yang memungkinkan Anda membuat dan melihat cakupan rekaman aktivitas. Izin ini tidak dapat disertakan dalam peran IAM khusus.

  9. Pilih tab untuk melihat bagaimana Anda berencana menggunakan contoh di halaman ini:

    Konsol

    Saat menggunakan konsol Google Cloud untuk mengakses layanan Google Cloud dan API, Anda tidak perlu menyiapkan autentikasi.

    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.

    Terraform

    Untuk menggunakan contoh Terraform di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

    1. Instal Google Cloud CLI.

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

    3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda:

      gcloud auth application-default login

      Anda tidak perlu melakukan langkah ini jika menggunakan Cloud Shell.

      Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, konfirmasi bahwa Anda telah login ke gcloud CLI dengan identitas gabungan Anda.

    Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal dalam dokumentasi autentikasi Google Cloud .

    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 .

Mencantumkan cakupan rekaman aktivitas

Konsol

Untuk mencantumkan cakupan rekaman aktivitas, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Setelan:

    Buka Setelan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  3. Pilih tab Cakupan Pelacakan.

    Jendela ini menampilkan daftar cakupan rekaman aktivitas Anda. Entri yang menyertakan ikon "Default", , adalah cakupan rekaman aktivitas default.

  4. Untuk melihat detail cakupan rekaman aktivitas, luaskan cakupan tersebut.

    Jika Anda memperluas cakupan rekaman aktivitas, Anda dapat melihat daftar tampilan yang disertakan dalam cakupan. Setiap baris mencantumkan project ID beserta entri seperti _Trace/Spans/_AllSpans, yang mengidentifikasi lokasi penyimpanan default untuk data rekaman aktivitas Anda. Kolom _Trace, Spans, dan _AllSpans merujuk ke bucket, set data, dan tampilan kemampuan observasi untuk data trace Anda. Tampilan _AllSpans sesuai dengan setiap entri dalam bucket:

    Nama Deskripsi Jenis Resource
    _Default Trace scope 1
    myscope My description Trace scope 2
      _Trace/Spans/_AllSpans myproject Trace view
      _Trace/Spans/_AllSpans project-b Trace view

gcloud

Tidak didukung.

Terraform

Anda dapat menggunakan Terraform untuk membuat dan mengubah cakupan rekaman aktivitas. Namun, Anda tidak dapat menggunakan Terraform untuk mencantumkan cakupan rekaman aktivitas.

REST

Untuk mencantumkan semua cakupan rekaman aktivitas dalam project Google Cloud , gunakan perintah projects.locations.traceScopes.list. Anda harus menentukan parameter jalur.

Parameter jalur untuk endpoint ini memiliki sintaksis berikut:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  • LOCATION_ID harus disetel ke global.

Responsnya adalah array objek TraceScope. Setiap objek mencakup nama dan daftar resource.

Untuk mendapatkan informasi tentang cakupan rekaman aktivitas tertentu, gunakan perintah projects.locations.traceScopes.get.

Membuat cakupan rekaman aktivitas

Rentang yang ditampilkan oleh halaman Trace Explorer bergantung pada tampilan yang dicari, peran IAM Anda pada tampilan tersebut, setelan rentang waktu, dan filter yang Anda terapkan.

Anda dapat membuat 100 cakupan rekaman aktivitas per project. Cakupan rekaman aktivitas dapat mencakup total 20 tampilan.

Konsol

Untuk membuat cakupan rekaman aktivitas, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Setelan:

    Buka Setelan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  3. Pilih tab Cakupan Pelacakan, lalu klik Buat cakupan pelacakan.
  4. Klik Tambahkan project dan selesaikan dialog.

  5. Di bagian Cakupan rekaman aktivitas nama, masukkan nama dan deskripsi yang ingin Anda tampilkan di tab Cakupan Rekaman Aktivitas.

    Nama cakupan rekaman aktivitas tidak dapat diubah dan harus unik dalam project.

  6. Klik Buat cakupan rekaman aktivitas.

    Secara default, tabel Cakupan rekaman aktivitas mencantumkan cakupan rekaman aktivitas Anda dalam bentuk diciutkan. Untuk setiap cakupan, tabel mencantumkan nama, deskripsi, jenis, dan jumlah resource.

    Jika Anda memperluas cakupan rekaman aktivitas, Anda dapat melihat daftar tampilan yang disertakan dalam cakupan. Setiap baris mencantumkan project ID beserta entri seperti _Trace/Spans/_AllSpans, yang mengidentifikasi lokasi penyimpanan default untuk data rekaman aktivitas Anda. Kolom _Trace, Spans, dan _AllSpans merujuk ke bucket, set data, dan tampilan kemampuan observasi untuk data trace Anda. Tampilan _AllSpans sesuai dengan setiap entri dalam bucket:

    Nama Deskripsi Jenis Resource
    _Default Trace scope 1
    myscope My description Trace scope 2
      _Trace/Spans/_AllSpans myproject Trace view
      _Trace/Spans/_AllSpans project-b Trace view

gcloud

Tidak didukung.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Untuk membuat cakupan rekaman aktivitas dalam project menggunakan Terraform, lakukan hal berikut:

  1. Gunakan resource Terraform google_observability_trace_scope.

    Dalam perintah, tetapkan kolom berikut:

    • project: Nama project, folder, atau organisasi Anda. Contoh, my-project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.

    • Tetapkan provider ke google-beta.

    • trace_scope_id: Ditetapkan ke ID cakupan. Contoh, my-trace-scope.

    • Tetapkan location ke "global".

    • resource_names: Array project, dengan setiap project ditentukan menggunakan nama yang sepenuhnya memenuhi syarat.

    • description: Deskripsi singkat. Misalnya, "Cakupan untuk resource produksi".

  2. Setelah memperbarui file main.tf, upgrade penginstalan Terraform Anda:

    terraform -init upgrade
    

    Upgrade diperlukan karena resource google_observability_trace_scope berstatus beta.

REST

Untuk membuat cakupan rekaman aktivitas, gunakan perintah projects.locations.traceScopes.create. Anda harus menentukan parameter jalur dan memberikan objek TraceScope. Responsnya adalah objek TraceScope.

Parameter jalur untuk endpoint ini memiliki sintaksis berikut:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  • LOCATION_ID harus disetel ke global.

Mengubah atau menghapus cakupan rekaman aktivitas

Anda tidak dapat menghapus atau mengubah cakupan rekaman aktivitas yang bernama _Default. Anda dapat mengubah atau menghapus semua cakupan rekaman aktivitas lainnya.

Konsol

Untuk mengubah atau menghapus cakupan rekaman aktivitas, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Setelan:

    Buka Setelan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  3. Pilih tab Cakupan Pelacakan.
  4. Temukan cakupan rekaman aktivitas yang ingin Anda ubah atau hapus, klik  Lainnya, lalu lakukan salah satu hal berikut:

    • Untuk mengubahnya, pilih Edit cakupan, lalu lengkapi dialog.
    • Untuk menghapus, pilih Hapus cakupan, lalu lengkapi dialog.

gcloud

Tidak didukung.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Untuk mengubah cakupan rekaman aktivitas dalam project menggunakan Terraform, lakukan hal berikut:

  1. Gunakan resource Terraform google_observability_trace_scope.

  2. Setelah memperbarui file main.tf, upgrade penginstalan Terraform Anda:

    terraform -init upgrade
    

    Upgrade diperlukan karena resource google_observability_trace_scope berstatus beta.

REST

Mengubah cakupan

Untuk mengubah cakupan rekaman aktivitas, gunakan perintah projects.locations.traceScopes.patch. Anda harus menentukan parameter jalur, parameter kueri, dan memberikan objek TraceScope. Parameter kueri mengidentifikasi kolom mana yang diubah. Responsnya adalah objek TraceScope.

Parameter jalur untuk endpoint ini memiliki sintaksis berikut:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  • LOCATION_ID harus disetel ke global.
  • TRACE_SCOPE_NAME: Nama cakupan rekaman aktivitas. Contoh, my-trace-scope.

Menghapus cakupan

Untuk menghapus cakupan rekaman aktivitas, gunakan perintah projects.locations.traceScopes.delete. Anda harus menentukan parameter jalur.

Parameter jalur untuk endpoint ini memiliki sintaksis berikut:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  • LOCATION_ID harus disetel ke global.
  • TRACE_SCOPE_NAME: Nama cakupan rekaman aktivitas. Contoh, my-trace-scope.

Mengonfigurasi cakupan rekaman aktivitas default

Saat halaman Trace Explorer terbuka, halaman tersebut akan menelusuri tampilan yang tercantum dalam cakupan rekaman aktivitas default untuk data rekaman aktivitas. Jika cakupan rekaman aktivitas tersebut tidak dapat diakses, halaman Trace Explorer akan mengkueri tampilan _AllSpans project Anda pada set data default.

Saat project dibuat, cakupan rekaman aktivitas bernama _Default akan dibuat dan ditetapkan sebagai cakupan rekaman aktivitas default. Namun, Anda dapat membuat cakupan rekaman aktivitas Anda sendiri dan menetapkannya sebagai cakupan rekaman aktivitas default.

Konsol

Untuk menyetel cakupan rekaman aktivitas default, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Setelan:

    Buka Setelan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  3. Pilih tab Cakupan Pelacakan.

    Tab ini menampilkan cakupan rekaman aktivitas Anda dan menyertakan tombol untuk membuat cakupan rekaman aktivitas kustom. Cakupan rekaman aktivitas yang ditampilkan dengan ikon "Default", , adalah cakupan rekaman aktivitas default saat ini.

  4. Untuk mengubah cakupan rekaman aktivitas default, temukan cakupan rekaman aktivitas yang ingin Anda tetapkan sebagai cakupan rekaman aktivitas default, klik  Lainnya, lalu pilih Tetapkan sebagai default.

    Cakupan rekaman aktivitas yang Anda pilih ditampilkan dengan ikon "Default", .

gcloud

Tidak didukung.

Terraform

Anda dapat menggunakan Terraform untuk membuat dan mengubah cakupan rekaman aktivitas. Namun, Anda tidak dapat menggunakan Terraform untuk menetapkan cakupan rekaman aktivitas default.

REST

Untuk mendapatkan dan menyetel cakupan log default atau cakupan rekaman aktivitas default menggunakan panggilan API, Anda mengonfigurasi cakupan kemampuan pengamatan. Cakupan kemampuan observasi mencantumkan cakupan log default dan cakupan rekaman aktivitas default:

  • Untuk mendapatkan cakupan kemampuan pengamatan default untuk project, kirim permintaan ke endpoint projects.locations.scopes.get. Anda harus menentukan parameter jalur. Respons adalah objek Scope, yang mencantumkan cakupan log default dan cakupan rekaman aktivitas default.

  • Untuk memperbarui cakupan kemampuan pengamatan default untuk project, kirim permintaan ke endpoint projects.locations.scopes.patch. Anda harus menentukan parameter jalur, parameter kueri, dan memberikan objek Scope. Parameter kueri mengidentifikasi kolom mana yang diubah. Responsnya adalah objek Scope.

Parameter jalur untuk kedua endpoint memiliki format berikut:

projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID

Kolom dalam ekspresi sebelumnya memiliki arti berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host atau project pengelolaan App Hub.
  • LOCATION: Kolom lokasi harus ditetapkan ke global.
  • OBSERVABILITY_SCOPE_ID: Nama objek Scope. Kolom ini harus disetel ke _Default. Objek Scope dengan nama _Default, yang dibuat secara otomatis, menyimpan informasi tentang cakupan log default dan cakupan rekaman aktivitas default.

Untuk mengirim perintah ke endpoint API, Anda dapat menggunakan APIs Explorer, yang memungkinkan Anda mengeluarkan perintah dari halaman referensi. Misalnya, untuk mendapatkan cakupan default saat ini, Anda dapat melakukan hal berikut:

  1. Klik projects.locations.scopes.get.
  2. Di widget Try this method, masukkan berikut ini di kolom name:

    projects/PROJECT_ID/locations/global/scopes/_Default
    

    Sebelum Anda menyalin kolom sebelumnya, ganti PROJECT_ID dengan nama project Anda.

  3. Pilih Jalankan.

  4. Dalam dialog otorisasi, selesaikan langkah-langkah yang diperlukan.

    Responsnya mirip dengan hal berikut ini:

    {
    "name": "projects/my-project/locations/global/scopes/_Default",
    "logScope": "logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default"
    "traceScope": "projects/my-project/locations/global/traceScopes/_Default"
    }
    

Batas cakupan rekaman aktivitas

Batas cakupan rekaman aktivitas Nilai
Jumlah maksimum cakupan rekaman aktivitas per project 100
Jumlah maksimum tampilan per cakupan rekaman aktivitas 20

Langkah berikutnya