Ringkasan cakupan observabilitas

Dokumen ini menjelaskan cara mengonfigurasi satu project Google Cloud untuk memantau atau menampilkan data telemetri dari beberapa project Google Cloud. Jika hanya ingin memantau atau melihat data yang disimpan di satu project Google Cloud, Anda tidak perlu melakukan konfigurasi apa pun, karena alat visualisasi dan analisis dikonfigurasi untuk menggunakan data yang disimpan di project Google Cloud yang dipilih oleh pemilih project. Namun, jika data telemetri yang ingin Anda lihat atau analisis berasal dari beberapa project, untuk memiliki tampilan gabungan data tersebut, Anda harus melakukan beberapa aktivitas konfigurasi.

Tentang cakupan kemampuan observasi

Alat analisis dan visualisasi Google Cloud Observability mengandalkan cakupan khusus jenis data untuk menentukan data yang akan ditampilkan atau dianalisis. Cakupan menentukan resource yang ditelusuri untuk jenis data tertentu. Dengan pengecualian data metrik, peran Identity and Access Management (IAM) Anda pada project yang ditelusuri dan tampilan log menentukan data yang ditampilkan.

Anda dapat mengonfigurasi cakupan berikut:

Cakupan kemampuan observasi

Cakupan ini mengontrol cara halaman penjelajah dan dasbor menelusuri data yang akan ditampilkan. Setiap project Google Cloud berisi satu cakupan visibilitas, yang mencantumkan cakupan log default, cakupan metrik, dan cakupan rekaman aktivitas default.

Sebaiknya konfigurasikan komponen cakupan visibilitas dalam skenario berikut:

  • Anda mendaftarkan aplikasi dengan App Hub. Aplikasi ini mungkin adalah aplikasi yang Anda daftarkan sendiri, atau yang Anda deploy menggunakan Application Design Center.
  • Jika Anda menginginkan tampilan terpadu data telemetri yang disimpan di project Google Cloud yang berbeda.

Jika Anda tidak mengonfigurasi komponen cakupan visibilitas untuk project, halaman Logs Explorer akan menampilkan data log yang berasal dari project. Halaman Metrics Explorer dan Trace Explorer hanya dapat menampilkan data yang disimpan dalam project. Selain itu, kebijakan pemberitahuan hanya dapat memantau data yang disimpan dalam project.

Cakupan log

Konfigurasikan cakupan log default project sehingga saat Anda membuka halaman Logs Explorer, data yang biasanya ingin Anda lihat akan ditampilkan. Cakupan log dapat mencantumkan project, folder, organisasi, dan tampilan log. Misalnya, Anda dapat menetapkan cakupan log default untuk mencantumkan tampilan log, yang saat dikueri, akan menampilkan data log untuk aplikasi App Hub.

Anda dapat membuat beberapa cakupan log. Saat menggunakan halaman Logs Explorer, Anda dapat memilih cakupan log yang berbeda, yang menyebabkan halaman menelusuri resource yang tercantum dalam cakupan yang dipilih, lalu memuat ulang tampilan.

Sebaiknya konfigurasikan cakupan log default dalam skenario berikut:

  • Anda merutekan data log ke bucket log terpusat.
  • Anda merutekan data log ke project lain atau ke bucket log yang disimpan oleh project lain.
  • Anda menggunakan tampilan log.

Untuk informasi selengkapnya, lihat Membuat dan mengelola cakupan log.

Cakupan metrik

Konfigurasikan cakupan metrik untuk mencantumkan semua project yang menyimpan data metrik, sehingga diagram dan kebijakan pemberitahuan Anda dapat menampilkan atau memantau tampilan gabungan data metrik.

Setiap project Google Cloud berisi satu cakupan metrik, dan cakupan ini secara default hanya mencantumkan project.

Sebaiknya konfigurasikan cakupan metrik jika salah satu hal berikut berlaku:

  • Anda ingin membuat diagram data yang disimpan di project yang berbeda.
  • Anda ingin kebijakan pemberitahuan untuk memantau data yang disimpan di project yang berbeda.
  • Anda mendaftarkan aplikasi dengan App Hub. Untuk informasi tentang skenario ini, lihat Cakupan metrik untuk project pengelolaan.

Untuk informasi selengkapnya, lihat Ringkasan cakupan metrik.

Cakupan rekaman aktivitas

Konfigurasikan cakupan rekaman aktivitas default untuk mencantumkan semua project yang menyimpan data rekaman aktivitas, sehingga saat membuka halaman Trace Explorer, Anda memiliki tampilan gabungan data rekaman aktivitas.

Anda dapat membuat beberapa cakupan rekaman aktivitas. Saat menggunakan halaman Trace Explorer, Anda dapat memilih cakupan rekaman aktivitas yang berbeda, yang menyebabkan halaman menelusuri project yang tercantum dalam cakupan yang dipilih, lalu memuat ulang tampilan.

Sebaiknya konfigurasikan cakupan rekaman aktivitas jika Anda menginginkan tampilan terpadu data rekaman aktivitas yang disimpan di project yang berbeda.

Untuk informasi selengkapnya, lihat Membuat dan mengelola cakupan rekaman aktivitas.

Sebelum memulai

Untuk mendapatkan izin yang Anda perlukan untuk membuat dan melihat cakupan, minta administrator untuk memberi Anda peran IAM berikut:

  • Untuk membuat dan melihat cakupan log serta mendapatkan cakupan log default: Logs Configuration Writer (roles/logging.configWriter) di project Anda
  • Untuk mengubah cakupan metrik: Monitoring Admin (roles/monitoring.admin) di project Anda dan di setiap project yang ingin ditambahkan ke cakupan metrik
  • Untuk membuat dan melihat cakupan rekaman aktivitas serta mendapatkan cakupan rekaman aktivitas default: Cloud Trace User (roles/cloudtrace.user) di project Anda
  • Untuk mendapatkan dan menetapkan cakupan default: Observability Editor (roles/observability.editor) di project Anda

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran yang telah ditetapkan ini berisi izin yang diperlukan untuk membuat dan melihat cakupan. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk membuat dan melihat cakupan:

  • Untuk mengonfigurasi cakupan log: logging.logScopes.{create, delete, get, list, update}
  • Untuk mengonfigurasi cakupan metrik: monitoring.metricsscopes.{link, get, list}
  • Untuk mengonfigurasi cakupan rekaman aktivitas: cloudtrace.traceScopes.{create, delete, get, list, update}
  • Untuk mendapatkan dan menetapkan cakupan default: observability.scopes.{get, update}

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Mengonfigurasi cakupan observabilitas

Bagian ini tidak berlaku untuk folder atau organisasi.

Jika Anda tidak mengonfigurasi komponen cakupan visibilitas untuk project, halaman Logs Explorer akan menampilkan data log yang berasal dari project. Halaman Metrics Explorer dan Trace Explorer hanya dapat menampilkan data yang disimpan dalam project. Selain itu, kebijakan pemberitahuan hanya dapat memantau data yang disimpan di project Anda.

Untuk data log dan rekaman aktivitas, peran Identity and Access Management (IAM) Anda di project yang Anda lihat, serta project yang ditelusuri dan tampilan log, menentukan data yang ditampilkan. Peran IAM Anda pada project yang Anda lihat menentukan apakah Anda dapat melihat data metrik.

Konsol

Untuk mengonfigurasi cakupan visibilitas, Anda mengonfigurasi komponennya, yaitu cakupan log default, cakupan metrik, dan cakupan rekaman aktivitas default:

  1. Enable the Observability API.

    Enable the API

    Sebelum mengaktifkan API, pastikan project yang benar telah dipilih. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mengaktifkan aplikasi.

  2. Di konsol Google Cloud, buka halaman  Settings:

    Buka Setelan

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

  3. Di toolbar konsol Google Cloud, pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mengaktifkan aplikasi.

  4. Konfigurasikan cakupan log default:

    1. Pilih tab Log Scopes.

      Cakupan log yang ada akan dicantumkan. Entri dengan ikon "Default", , adalah cakupan log default. Jika Anda ingin membuat cakupan log, klik Create log scope, lalu selesaikan dialog. Untuk informasi selengkapnya, lihat Membuat dan mengelola cakupan log.

    2. Temukan entri yang ingin Anda tetapkan sebagai default, klik  Lainnya, lalu pilih Tetapkan sebagai default.

  5. Konfigurasikan cakupan metrik:

    1. Pilih tab cakupan metrik.
    2. Di panel Google Cloud Projects, klik Add Projects, lalu selesaikan dialog. Untuk informasi selengkapnya, lihat Mengonfigurasi cakupan metrik.
  6. Konfigurasikan cakupan rekaman aktivitas default:

    1. Pilih tab Trace Scopes, lalu lakukan hal berikut:

      Cakupan rekaman aktivitas yang ada akan dicantumkan. Entri dengan ikon "Default", , adalah cakupan rekaman aktivitas default. Jika Anda ingin membuat cakupan rekaman aktivitas, klik Create log scope, lalu selesaikan dialog. Untuk informasi selengkapnya, lihat Membuat dan mengelola cakupan rekaman aktivitas.

    2. Temukan entri yang ingin Anda tetapkan sebagai default, klik  Lainnya, lalu pilih Tetapkan sebagai default.

REST

Tidak didukung untuk menetapkan cakupan rekaman aktivitas default.

Untuk menggunakan Observability API guna mendapatkan atau menetapkan cakupan log default, lakukan hal berikut:

  1. Pastikan Observability API diaktifkan:

    1. After installing the Google Cloud CLI, initialize it by running the following command:

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    2. Tetapkan project default untuk Google Cloud CLI:

      gcloud config set project PROJECT_ID
      

      Sebelum menjalankan perintah sebelumnya, ganti hal berikut:

      • PROJECT_ID: ID project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mengaktifkan aplikasi.
    3. Enable the Observability API:

      gcloud services enable observability.googleapis.com
  2. Lakukan salah satu hal berikut:

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

    • Untuk memperbarui cakupan log 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 bentuk berikut:

      projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID
      

      Kolom dalam ekspresi sebelumnya memiliki arti sebagai berikut:

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