Menyimpan atau membagikan kueri SQL

Dokumen ini menjelaskan cara menyimpan dan membagikan kueri yang Anda buat di Observability Analytics.

Untuk mengetahui informasi tentang cara membuat diagram kueri atau contoh kueri, lihat dokumen yang tercantum di bagian Langkah berikutnya dalam dokumen ini.

Sebelum memulai

  1. Login keakun Anda. Google Cloud 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.

  8. Untuk mendapatkan izin yang Anda perlukan untuk memuat halaman Observability Analytics, menulis, menjalankan, dan menyimpan kueri pribadi , minta administrator untuk memberi Anda peran IAM berikut:

    • Observability View Accessor (roles/observability.viewAccessor) on the observability views that you want to query. Peran ini mendukung kondisi IAM, yang memungkinkan Anda membatasi pemberian akses ke tampilan tertentu. Jika Anda tidak melampirkan kondisi ke pemberian peran, akun utama dapat mengakses semua tampilan observabilitas. Tampilan observabilitas berada dalam Pratinjau Publik.
    • Observability Analytics User (roles/observability.analyticsUser) di project Anda. Peran ini berisi izin yang diperlukan untuk menyimpan dan menjalankan kueri pribadi, serta menjalankan kueri bersama.
    • Logs Viewer (roles/logging.viewer) di project Anda.
    • Logs View Accessor (roles/logging.viewAccessor) di project yang menyimpan tampilan log yang ingin Anda kueri.

    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.

Menyimpan kueri

Semua kueri yang Anda jalankan akan otomatis disimpan selama 30 hari dan dapat diakses dengan memilih tab Terbaru di halaman Observability Analytics. Anda dapat menelusuri, melihat, menjalankan, dan membagikan kueri yang tercantum di tab Terbaru.

Jika Anda ingin kueri tetap tersedia untuk digunakan di masa mendatang, tambahkan anotasi dengan informasi yang berguna bagi Anda, atau izinkan rekan tim melihat dan menjalankan kueri Anda, lalu simpan kueri tersebut. Anda dapat menelusuri dan mengurutkan kueri tersimpan berdasarkan nama, deskripsi, dan label visibilitasnya. Anda juga dapat mengedit dan menghapus kueri ini. Kueri yang Anda simpan akan dipertahankan hingga Anda menghapusnya.

Anda dapat menyimpan 10.000 kueri per Google Cloud project.

Konsol

Untuk menyimpan kueri, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman Log Analytics:

    Buka Log Analytics

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

  2. Isi panel Query dengan kueri.

    Anda dapat mengisi panel Query dengan memasukkan kueri baru, memilih kueri dari tab Terbaru, atau memilih kueri dari tab Tersimpan.

    Kueri Anda dapat menyertakan tampilan valid, beberapa tampilan, dan tampilan analisis.

    Jika kueri di panel Query valid, maka Simpan akan diaktifkan.

  3. Klik Simpan, pilih Simpan kueri, dan isi kolom Nama dan Deskripsi. Nilai yang Anda tetapkan untuk kolom ini ditampilkan di tab Tersimpan.

  4. Opsional: Untuk mengizinkan semua orang yang memiliki akses ke halaman Observability Analytics untuk Google Cloud project melihat dan menjalankan kueri tersimpan Anda, aktifkan tombol Bagikan dengan project.

    Secara default, tombol ini dinonaktifkan dan visibilitasnya dibatasi untuk Anda.

  5. Klik Simpan kueri.

  6. Opsional: Untuk melihat, mengurutkan, dan menjalankan kueri tersimpan yang terlihat oleh Anda, pilih tab Tersimpan.

    Anda dapat mengurutkan dan memfilter kueri tersimpan berdasarkan nama, deskripsi, dan label visibilitasnya. Anda juga dapat memfilter berdasarkan konten kueri.

Anda dapat mengedit dan menghapus kueri yang Anda buat menggunakan opsi di tab Tersimpan:

  • Untuk mengedit kueri, klik Opsi Lainnya , lalu pilih Edit. Anda dapat mengubah nilai untuk kolom Nama dan Deskripsi ; namun, kueri itu sendiri tidak dapat diubah.

  • Untuk menghapus kueri tersimpan, klik Opsi Lainnya , lalu pilih Hapus.

REST

Anda dapat menyimpan kueri menggunakan Cloud Logging API. Untuk menyimpan kueri, gunakan metode savedQueries.create.

Untuk menjalankan metode ini, lakukan hal berikut:

  1. Pilih savedQueries.create.
  2. Di halaman referensi, gunakan APIs Explorer untuk mengeluarkan perintah. Anda harus menentukan kolom opsAnalyticsQuery.

Contoh berikut menggambarkan isi permintaan contoh, yang berisi instance SavedQuery:

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

Membagikan kueri

Anda dapat membagikan kueri tersimpan kepada semua orang yang memiliki akses ke Google Cloud project Anda. Namun, peran IAM akun utama menentukan apakah kueri dapat dijalankan dan data yang ditampilkan kueri.

Konsol

Saat memecahkan masalah, atau saat melihat hasil yang anomali, Anda mungkin ingin membagikan kueri dan hasilnya kepada rekan tim. Saat melihat hasil kueri di halaman Observability Analytics, Anda dapat menyalin URL yang, saat dibuka, akan menampilkan kueri yang Anda jalankan dan hasilnya.

Untuk membagikan kueri dan hasil kepada rekan tim, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman Log Analytics:

    Buka Log Analytics

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

  2. Isi panel Query dengan kueri, lalu klik Run query.

    Anda dapat mengisi panel Query dengan memasukkan kueri baru, memilih kueri dari tab Terbaru, atau memilih kueri dari tab Tersimpan.

  3. Klik Bagikan link.

  4. Kirim link ke rekan tim Anda.

    Saat rekan tim Anda membuka link, halaman Observability Analytics akan terbuka dan menampilkan kueri, tetapi tidak menjalankannya. Rekan tim Anda harus menjalankan kueri secara manual.

    Halaman Observability Analytics menampilkan dialog peringatan saat kueri berjalan di mesin BigQuery dan resource yang dikueri tidak berada dalam batas kepemilikan yang sama. Batas kepemilikan ditentukan oleh beberapa faktor, salah satunya adalah hierarki resource yang digunakan kueri.

    Agar URL berhasil dibuka, peran IAM rekan tim Anda di Google Cloud project harus menyertakan izin yang diperlukan untuk melihat halaman Observability Analytics.

REST

Anda dapat menggunakan Logging API untuk membuat kueri bersama menggunakan metode savedQueries.Create, dan menentukan nilai SHARED di kolom visibility. Untuk mengetahui informasi selengkapnya, lihat halaman referensi untuk savedQueries.create.

Melihat dan menjalankan kueri terbaru atau tersimpan

Untuk melihat atau menjalankan kembali kueri, pilih tab Terbaru di halaman Observability Analytics dan temukan kueri:

  • Untuk menjalankan kueri, klik Run.
  • Untuk melihat kueri, gunakan opsi di menu Opsi Lainnya.

Untuk melihat, mengedit, atau menjalankan kueri tersimpan, pilih tab Tersimpan di halaman Observability Analytics dan temukan kueri:

  • Untuk menjalankan kueri, klik Run.
  • Untuk mengedit, melihat, atau menghapus kueri, gunakan opsi di menu Opsi Lainnya.

Langkah berikutnya