Menyimpan dan membagikan kueri SQL

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

Dokumen ini mengasumsikan bahwa Anda sudah memahami Observability Analytics dan cara menggunakan halaman Observability Analytics untuk mengkueri data log Anda. Jika Anda belum memahami topik ini, lihat Mengkueri dan menganalisis log.

Untuk mempelajari cara membuat diagram hasil kueri dan cara menyimpan diagram tersebut ke dasbor kustom, lihat Membuat diagram hasil kueri SQL.

Perbedaan antara kueri tersimpan dan tampilan analisis

Kueri tersimpan adalah kueri yang Anda jalankan menggunakan halaman Observability Analytics , lalu disimpan sebagai kueri. Tindakan penyimpanan memungkinkan Anda menjalankan kembali kueri ini kapan saja. Saat menyimpan kueri, Anda memiliki opsi untuk menjadikannya pribadi, atau Anda dapat membuatnya terlihat oleh orang lain yang memiliki izin yang diperlukan untuk menggunakan Observability Analytics. Anda tidak dapat menulis kueri SQL yang klausa FROM menentukan kueri tersimpan.

_Tampilan analisis_ berisi kueri yang dapat Anda jalankan kembali kapan saja. Anda membuat tampilan analisis dengan menulis kueri SQL terhadap tampilan log, lalu menyimpan hasilnya sebagai tampilan. Tidak seperti kueri tersimpan, Anda tidak dapat menjadikan tampilan analisis pribadi. Anda dapat mengkueri tampilan analisis. Kemampuan ini memungkinkan Anda mengubah data log dari format LogEntry menjadi format lain yang lebih sesuai untuk Anda. Kemudian, alih-alih menulis kueri terhadap tampilan log, Anda mengkueri tampilan analisis.

Anda dapat menyimpan kueri yang mengkueri tampilan log atau tampilan analisis.

Sebelum memulai

Bagian ini menjelaskan langkah-langkah yang harus Anda selesaikan sebelum dapat menggunakan Observability Analytics.

Mengonfigurasi bucket log

Pastikan bucket log Anda telah diupgrade untuk menggunakan Observability Analytics:

1. Di Google Cloud konsol, buka halaman Logs Storage:

   Buka Logs Storage

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

2. Untuk setiap bucket log yang memiliki tampilan log yang ingin Anda kueri, pastikan kolom Observability Analytics available menampilkan Open. Jika Upgrade ditampilkan, klik Upgrade dan selesaikan dialog.

Mengonfigurasi peran dan izin IAM

Bagian ini menjelaskan peran atau izin IAM yang diperlukan untuk menggunakan Observability Analytics:

• Untuk mendapatkan izin yang diperlukan untuk menggunakan Observability Analytics dan mengkueri tampilan log, minta administrator untuk memberi Anda peran IAM berikut di project Anda:

  • Untuk mengkueri bucket log _Required dan _Default: Logs Viewer (roles/logging.viewer)
  • Untuk mengkueri semua tampilan log dalam project: Logs View Accessor (roles/logging.viewAccessor)

  Anda dapat membatasi prinsipal ke tampilan log tertentu dengan menambahkan kondisi IAM ke pemberian peran Logs View Accessor yang dibuat di tingkat project, atau dengan menambahkan binding IAM ke file kebijakan tampilan log. Untuk mengetahui informasi selengkapnya, lihat Mengontrol akses ke tampilan log.

  Izin ini sama dengan izin yang Anda perlukan untuk melihat entri log di halaman Logs Explorer. Untuk mengetahui informasi tentang peran tambahan yang Anda perlukan untuk mengkueri tampilan di bucket yang ditentukan pengguna atau untuk mengkueri tampilan _AllLogs dari bucket log _Default, lihat Peran Cloud Logging.

• Untuk mendapatkan izin yang diperlukan untuk mengkueri tampilan analisis, minta administrator untuk memberi Anda peran IAM Observability Analytics User (roles/observability.analyticsUser) di project Anda.

Menyimpan kueri

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

Jika Anda ingin menyimpan kueri untuk digunakan di masa mendatang, beri 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 Recent, atau memilih kueri dari tab Saved.

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

   Jika kueri di panel Query valid, tombol save Save akan diaktifkan.

3. Klik save Save, pilih Save query, dan isi kolom Name dan Description. Nilai yang Anda tetapkan untuk kolom ini akan ditampilkan di tab Saved.

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 Share with project.

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

5. Klik Save query.

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

   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 Saved:

• Untuk mengedit kueri, klik More Options , lalu pilih Edit. Anda dapat mengubah nilai untuk kolom Name dan Description ; namun, kueri itu sendiri tidak dapat diubah.

• Untuk menghapus kueri tersimpan, klik More Options , lalu pilih Delete.

API

Untuk menyimpan kueri menggunakan Logging API, gunakan metode savedQueries.create. Untuk mengetahui informasi selengkapnya tentang metode ini, parameternya, dan data respons, lihat halaman referensi untuk savedQueries.create.

Anda dapat menjalankan metode savedQueries.create menggunakan APIs Explorer widget di halaman referensi metode. Untuk kueri Observability Analytics, Anda harus menentukan kolom opsAnalyticsQuery. Contoh berikut mengilustrasikan 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 prinsipal 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 hasilnya 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 Recent, atau memilih kueri dari tab Saved.

3. Klik Share 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.

API

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 Recent di halaman Observability Analytics dan temukan kueri:

• Untuk menjalankan kueri, klik Run.
• Untuk melihat kueri, gunakan opsi di menu More Options.

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

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

Langkah berikutnya

• Membuat dan mengkueri tampilan analisis
• Contoh kueri SQL
• Membuat diagram hasil kueri SQL
• Mengkueri set data tertaut di BigQuery