Membuat dan mengelola cakupan log

Dokumen ini menjelaskan cara membuat dan mengelola cakupan log, yang dapat Anda gunakan untuk membantu Anda menemukan entri log yang ingin Anda lihat atau analisis secara efisien. Jika Anda hanya ingin melihat dan menganalisis entri log yang berasal dari project, folder, atau organisasi, dokumen ini tidak ditujukan untuk Anda. Namun, jika Anda mengandalkan log sink untuk merutekan log ke project lain atau ke bucket log yang ditentukan pengguna, atau jika Anda menggunakan tampilan log, informasi dalam dokumen ini dapat membantu Anda menemukan entri log tertentu secara efisien.

Dokumen ini tidak menjelaskan cara melihat log Anda. Untuk informasi tentang topik tersebut, lihat Melihat log menggunakan Logs Explorer.

Tentang cakupan log

Cakupan log adalah resource level project persisten yang mencantumkan kumpulan resource. Resource ini dapat berupa project, folder, organisasi, dan tampilan log. Misalnya, Anda dapat menentukan cakupan log yang mencantumkan project yang berisi resource yang digunakan untuk produksi, atau yang mencantumkan tampilan log yang menyertakan entri log untuk jenis resource tertentu.

Saat Anda membuat project, folder, atau resource organisasi Google Cloud, logging akan membuat cakupan log bernama _Default. Cakupan ini mencakup project, folder, atau organisasi yang dibuat. Jika resource yang ditelusuri adalah project, folder, atau organisasi Google Cloud, hasilnya akan menyertakan entri log yang berasal dari resource tersebut, lalu disimpan di bucket log. Saat project ditelusuri, hasilnya juga mencakup entri log yang dirutekan ke project oleh sink di project lain, lalu disimpan di bucket log.

Anda dapat membuat cakupan log. Anda juga dapat mengedit dan menghapus cakupan log yang Anda buat. Namun, Anda tidak dapat mengedit atau menghapus cakupan log bernama _Default.

Anda menggunakan cakupan log untuk mengontrol resource yang akan ditelusuri oleh halaman Logs Explorer untuk menemukan data log. Saat Anda membuka halaman tersebut dan memilih cakupan log, halaman akan menelusuri resource yang tercantum dalam cakupan tersebut, lalu memuat ulang tampilan.

Anda juga dapat menggunakan cakupan log untuk mengontrol resource yang ditelusuri panel log untuk menemukan data log. Panel log adalah widget dasbor kustom yang menampilkan data log. Setiap panel log memiliki konfigurasi sendiri, yang memungkinkan Anda membuat dasbor yang berisi beberapa panel log dengan setiap panel menampilkan data log yang berbeda. Untuk informasi selengkapnya, lihat Menampilkan log dan error di dasbor kustom.

Untuk project, cakupan log default menentukan kumpulan resource yang ditelusuri halaman Logs Explorer saat dibuka. Namun, peran Identity and Access Management (IAM) Anda pada resource yang ditelusuri dan setelan rentang waktu menentukan entri log mana yang diambil dari penyimpanan. Saat project dibuat, cakupan log bernama _Default ditetapkan sebagai cakupan log default. Anda dapat menetapkan cakupan log mana yang merupakan cakupan log default.

Praktik terbaik

Karena cakupan log menyediakan cara bagi Anda untuk menentukan dan menyimpan konfigurasi untuk digunakan di masa mendatang, sebaiknya Anda membuat cakupan log untuk konfigurasi penelusuran yang kompleks.

Misalnya, Anda sedang memecahkan masalah dan ingin melihat entri log untuk semua instance virtual machine (VM) yang dimiliki oleh tim Anda. Untuk menyelesaikan tugas ini, Anda dapat melakukan hal berikut:

  1. Anda menentukan bahwa entri log yang ingin dilihat disimpan di beberapa bucket log dan di beberapa project. Untuk sebagian besar bucket log, tersedia tampilan log yang menyertakan entri log yang ingin Anda analisis. Jika tampilan log tidak ada, Anda dapat membuatnya.

  2. Anda memutuskan untuk membuat cakupan log karena Anda berharap akan memiliki tugas pemecahan masalah serupa di masa mendatang.

  3. Anda membuka halaman Logs Explorer di konsol Google Cloud, lalu menggunakan menu Refine scope untuk memilih cakupan log baru.

  4. Anda meninjau entri log dan menemukan informasi yang diperlukan untuk menyelesaikan masalah yang sedang Anda selidiki.

  5. Setelah menyelesaikan masalah, Anda membagikan penyebab kegagalan kepada kolega. Anda juga menyampaikan bahwa Anda mungkin akan melihat kegagalan serupa di masa mendatang, sehingga Anda membuat cakupan log yang akan memungkinkan Anda, atau siapa saja yang menyelidiki kegagalan, menemukan entri log yang relevan dengan cepat.

Batasan

  • Anda tidak dapat menghapus atau mengubah cakupan log bernama _Default.
  • Hanya project Google Cloud yang mendukung cakupan log default.
  • Anda tidak dapat menambahkan folder atau organisasi ke cakupan log yang ditentukan pengguna.
  • Cakupan log dibuat di lokasi global.

Sebelum memulai

  • Untuk mendapatkan izin yang diperlukan guna membuat dan melihat cakupan log, serta menetapkan cakupan log default, minta administrator untuk memberi Anda peran IAM berikut:

    • Untuk membuat dan melihat cakupan log atau mendapatkan cakupan log default: Logs Configuration Writer (roles/logging.configWriter) di project, folder, atau organisasi Anda
    • Untuk menetapkan cakupan log default: Observability Editor (roles/observability.editor) di project, folder, atau organisasi Anda

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

    Peran bawaan ini berisi izin yang diperlukan untuk membuat dan melihat cakupan log, serta menetapkan cakupan log default. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

    Izin yang diperlukan

    Izin berikut diperlukan untuk membuat dan melihat cakupan log, serta menetapkan cakupan log default:

    • Untuk mendapatkan dan menetapkan cakupan log default: observability.scopes.{get, update}

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

  • Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

    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. Install the Google Cloud CLI.
    2. To initialize the gcloud CLI, run the following command:

      gcloud init
    3. If you're using a local shell, then create local authentication credentials for your user account:

      gcloud auth application-default login

      You don't need to do this if you're using Cloud Shell.

    Untuk informasi selengkapnya, lihat Menyiapkan autentikasi 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.

      Install the Google Cloud CLI, then initialize it by running the following command:

      gcloud init

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

Mencantumkan cakupan log

Konsol

Untuk mencantumkan cakupan log, lakukan hal berikut:

  1. Di konsol Google Cloud, buka halaman  Settings:

    Buka Setelan

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

  2. Pilih tab Log Scopes.

    Tabel mencantumkan cakupan log Anda. Setelah Anda memilih project Google Cloud, satu entri dalam tabel akan ditampilkan dengan ikon "Default", , yang menunjukkan bahwa cakupan log ini mencantumkan resource yang ditelusuri Logs Explorer saat halaman tersebut dibuka.

gcloud

Untuk mencantumkan cakupan log dalam project, gunakan perintah gcloud logging scopes list:

 gcloud logging scopes list --project=PROJECT_ID

Sebelum menjalankan perintah, perbarui kolom berikut:

  • PROJECT_ID: ID project.

Untuk mendapatkan detail cakupan log dalam project, gunakan perintah gcloud logging scopes describe:

 gcloud logging scopes describe LOG_SCOPE --project=PROJECT_ID

Sebelum menjalankan perintah, perbarui kolom berikut:

  • PROJECT_ID: ID project.
  • LOG_SCOPE: Nama cakupan log. Contoh, my-scope.

Terraform

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

REST

Cloud Logging API berisi perintah yang mencantumkan cakupan log dalam resource, atau yang melaporkan detail cakupan log tertentu. Untuk mengetahui daftar lengkap perintah, lihat dokumentasi referensi API.

Untuk project Google Cloud, gunakan perintah berikut:

Dalam perintah API, tetapkan kolom locations ke global.

Menetapkan cakupan log default

Cakupan log default mencantumkan resource yang ditelusuri oleh halaman Logs Explorer saat halaman tersebut terbuka. Jika cakupan log default tidak ada atau tidak dapat diakses, halaman tersebut akan otomatis menelusuri entri log yang berasal dari project, folder, atau organisasi yang dipilih. Entri log yang ditampilkan oleh halaman Logs Explorer bergantung pada resource yang ditelusuri, setelan rentang waktu, dan peran IAM Anda pada resource yang ditelusuri.

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

Konsol

Untuk menetapkan cakupan log default, lakukan hal berikut:

  1. Di konsol Google Cloud, buka halaman  Settings:

    Buka Setelan

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

  2. Pilih tab Log Scopes.
  3. Temukan cakupan log yang ingin Anda tetapkan sebagai cakupan log default, klik  Lainnya, lalu pilih Tetapkan sebagai default.

    Cakupan log yang Anda pilih ditampilkan dengan ikon "Default", .

gcloud

Tidak didukung.

Terraform

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

REST

Tidak didukung.

Membuat cakupan log

Anda dapat membuat 100 cakupan log per project. Cakupan log dapat mencakup total 100 tampilan log dan project; tetapi, cakupan log hanya dapat menyertakan 5 project. Anda tidak dapat menambahkan folder atau organisasi ke cakupan log.

Konsol

Untuk membuat cakupan log, lakukan hal berikut:

  1. Di konsol Google Cloud, buka halaman  Settings:

    Buka Setelan

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

  2. Pilih tab Cakupan Log, lalu klik Buat cakupan log.
  3. Untuk menambahkan satu atau beberapa project, klik Add projects, lalu selesaikan dialog.

    Setelah menambahkan project, peran IAM Anda di project tersebut akan menentukan entri log yang dapat Anda lihat. Misalnya, peran IAM Anda mungkin hanya mengizinkan Anda melihat entri log yang dapat diakses oleh tampilan log tertentu di bucket log. Untuk mengetahui informasi selengkapnya tentang peran, lihat Peran logging.

  4. Untuk menambahkan satu atau beberapa tampilan log, klik Tambahkan tampilan log, lalu selesaikan dialog.

    Dialog mencantumkan semua tampilan log yang memiliki entri log yang berasal dari project saat ini, atau yang dirutekan ke project saat ini oleh sink di project lain. Misalnya, jika Anda belum mengonfigurasi sink, dialog ini akan mencantumkan tampilan log dalam project Anda saat ini.

    Untuk mencantumkan tampilan log yang disimpan di project Google Cloud lain, klik  Import project, lalu pilih project Google Cloud.

    Setelah Anda menambahkan tampilan log, peran IAM Anda di tampilan log atau project yang menyimpan tampilan log akan menentukan entri log yang dapat Anda akses. Untuk mengetahui informasi selengkapnya, lihat Mengontrol akses ke tampilan log.

  5. Di bagian Nama cakupan log, masukkan nama dan deskripsi yang ingin Anda tampilkan di tab Cakupan Log.

    Nama cakupan log tidak dapat diubah dan harus unik dalam project.

  6. Klik Buat cakupan log.

gcloud

Untuk membuat cakupan log dalam project, gunakan perintah gcloud logging scopes create:

 gcloud logging scopes create LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

Sebelum menjalankan perintah, perbarui kolom berikut:

  • PROJECT_ID: ID project.
  • LOG_SCOPE: Nama cakupan log. Contoh, my-scope.

  • DESCRIPTION: Opsional. Deskripsi cakupan log. Format deskripsi sebagai string.

  • RESOURCE_NAMES: Daftar yang dipisahkan koma dari nama project atau tampilan log yang sepenuhnya memenuhi syarat. Misalnya, untuk menyertakan my-project dalam cakupan log, tentukan projects/my-project.

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 log di project, folder, atau organisasi menggunakan Terraform, gunakan resource Terraform google_logging_log_scope.

Dalam perintah, tetapkan kolom berikut:

  • parent: Nama lengkap project, folder, atau organisasi Anda. Misalnya, Anda dapat menetapkan kolom ini ke "projects/PROJECT_ID", dengan PROJECT_ID adalah ID project Google Cloud Anda.
  • locations: Tetapkan ke "global".
  • name: Tetapkan ke nama yang sepenuhnya memenuhi syarat dari cakupan log. Untuk project, format kolom ini adalah:

    "projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE"
    

    Dalam ekspresi sebelumnya, LOG_SCOPE adalah nama cakupan log, seperti "produksi".

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

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

REST

Cloud Logging API juga mendukung pembuatan cakupan log di folder atau organisasi. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API.

Untuk project Google Cloud, gunakan perintah berikut:

Dalam perintah API, tetapkan kolom locations ke global.

Mengubah atau menghapus cakupan log

Konsol

Untuk mengubah atau menghapus cakupan log yang Anda atau rekan kerja buat, lakukan hal berikut:

  1. Di konsol Google Cloud, buka halaman  Settings:

    Buka Setelan

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

  2. Pilih tab Log Scopes.
  3. Temukan Cakupan Log yang ingin Anda ubah atau hapus, klik  Lainnya, lalu lakukan salah satu tindakan berikut:

    • Untuk mengubah, pilih Edit cakupan, lalu selesaikan dialog.
    • Untuk menghapus, pilih Hapus cakupan, lalu selesaikan dialog.

gcloud

Untuk mengubah deskripsi daftar resource dalam cakupan log di project, gunakan perintah gcloud logging scopes update:

 gcloud logging scopes update LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

Sebelum menjalankan perintah, perbarui kolom berikut:

  • PROJECT_ID: ID project.
  • LOG_SCOPE: Nama cakupan log. Contoh, my-scope.

  • DESCRIPTION: Deskripsi cakupan log. Format deskripsi sebagai string. Hapus kolom ini jika Anda tidak ingin mengubah deskripsi cakupan log.

  • RESOURCE_NAMES: Daftar yang dipisahkan koma dari nama project atau tampilan log yang sepenuhnya memenuhi syarat. Hapus kolom ini jika Anda tidak ingin mengubah daftar resource.

Untuk menghapus cakupan log dalam project, gunakan perintah gcloud logging scopes delete:

 gcloud logging scopes delete LOG_SCOPE --project=PROJECT_ID

Sebelum menjalankan perintah, perbarui kolom berikut:

  • PROJECT_ID: ID project.
  • LOG_SCOPE: Nama cakupan log. Contoh, my-scope.

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 log di project, folder, atau organisasi menggunakan Terraform, gunakan resource Terraform google_logging_log_scope.

REST

Cloud Logging API berisi perintah yang dapat mengubah atau menghapus cakupan log. Untuk mengetahui daftar lengkap perintah, lihat dokumentasi referensi API.

Untuk project Google Cloud, gunakan perintah berikut:

Dalam perintah API, tetapkan kolom locations ke global.

Langkah selanjutnya