Observability Analytics memungkinkan Anda menyimpan dan membagikan kueri SQL sehingga Anda dapat menjalankan kembali investigasi Cloud Logging yang sering dilakukan dan berkolaborasi dengan anggota tim di seluruh project Anda. Anda dapat merahasiakan kueri tersimpan untuk penggunaan pribadi atau membagikannya kepada anggota project lain.
Jika Anda belum menulis kueri di Observability Analytics, lihat Membuat kueri dan menganalisis log terlebih dahulu. Untuk mempelajari cara membuat diagram hasil kueri dan menyimpan diagram tersebut ke dasbor kustom, lihat Membuat diagram hasil kueri SQL.
Perbedaan kueri tersimpan dengan tampilan analisis
Kueri tersimpan adalah kueri yang Anda jalankan menggunakan halaman Observability Analytics, lalu
disimpan sebagai kueri. Tindakan simpan memungkinkan Anda menjalankan ulang 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 dengan klausa FROM yang menentukan kueri tersimpan.
Tampilan analisis berisi kueri yang dapat Anda jalankan ulang sesuai keinginan. 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 bersifat pribadi untuk diri sendiri.
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 membuat kueri 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:
-
Di konsol Google Cloud , buka halaman Logs Storage:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
- 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 Anda perlukan untuk menggunakan Observability Analytics dan mengkueri tampilan log, minta administrator untuk memberi Anda peran IAM berikut di project Anda:
-
Untuk mengkueri bucket log
_Requireddan_Default: Logs Viewer (roles/logging.viewer) -
Untuk mengkueri semua tampilan log dalam project:
Logs View Accessor (
roles/logging.viewAccessor)
Anda dapat membatasi entitas ke tampilan log tertentu dengan menambahkan IAM Condition ke pemberian peran Logs View Accessor yang dibuat di level 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
_AllLogsdari bucket log_Default, lihat Peran Cloud Logging. -
Untuk mengkueri bucket log
-
Untuk mendapatkan izin yang diperlukan guna mengkueri tampilan analisis, minta administrator untuk memberi Anda peran IAM Observability Analytics User (
roles/observability.analyticsUser) di project Anda.
Pilih antarmuka yang ingin Anda gunakan
Konsol
Saat menggunakan konsol Google Cloud untuk mengakses layanan dan API Google Cloud , Anda tidak perlu menyiapkan autentikasi.
gcloud
Instal Google Cloud CLI, lalu login ke gcloud CLI dengan identitas gabungan Anda. Setelah login, inisialisasi Google Cloud CLI dengan menjalankan perintah berikut:
gcloud initREST
Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.
Instal Google Cloud CLI, lalu login ke gcloud CLI dengan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi Google Cloud .
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.
Untuk menggunakan kembali kueri, menambahkan deskripsi kustom, atau membagikannya kepada rekan satu tim, simpan kueri. 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 project Google Cloud .
Konsol
Untuk menyimpan kueri, lakukan hal berikut:
-
Di konsol Google Cloud , buka halaman manage_search Observability Analytics:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
Isi panel Query dengan kueri.
Anda dapat mengisi panel Query dengan memasukkan kueri baru, dengan memilih kueri dari tab Recent, atau dengan memilih kueri dari tab Saved.
Kueri Anda dapat menyertakan tampilan yang valid, beberapa tampilan, dan tampilan analisis.
Jika kueri di panel Query valid, tombol Save akan diaktifkan.
Klik Save, pilih Save query, lalu lengkapi kolom Name dan Description. Nilai yang Anda tetapkan untuk kolom ini ditampilkan di tab Tersimpan.
Opsional: Untuk mengizinkan semua orang yang memiliki akses ke halaman Observability Analytics untuk project Google Cloud melihat dan menjalankan kueri tersimpan Anda, aktifkan tombol Share with project.
Secara default, tombol ini dinonaktifkan dan visibilitasnya dibatasi untuk Anda.
Klik Save query.
Opsional: Untuk melihat, mengurutkan, dan menjalankan kueri tersimpan yang dapat Anda lihat, pilih tab Saved.
Anda dapat mengurutkan dan memfilter kueri tersimpan berdasarkan nama, deskripsi, dan label visibilitasnya. Anda juga dapat memfilter menurut konten kueri.
Anda dapat mengedit dan menghapus kueri yang Anda buat menggunakan opsi di tab Saved:
Untuk mengedit kueri, klik more_vert 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_vert More Options, lalu pilih Delete.
gcloud
Untuk membuat dan menyimpan kueri, lakukan hal berikut:
-
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- DISPLAY_NAME: Nama tampilan kueri tersimpan.
- LOCATION: Lokasi untuk kueri tersimpan.
- VISIBILITY: Tetapkan ke
privateatau keshared. - SQL_QUERY: Kueri SQL. Jika tanda kutip terbalik tunggal
(`)menggabungkan jalur atau kolom dalam jalur, Anda harus meng-escape tanda kutip terbalik tersebut:"SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"atau
"SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"Tanda kutip terbalik
(`)diperlukan jika elemen jalur berisi karakter titik(.). - ID: ID kueri tersimpan. ID ini adalah input yang diperlukan untuk perintah yang mendeskripsikan, memperbarui, atau menghapus kueri tersimpan. Jika Anda tidak memberikan ID saat membuat kueri tersimpan, sistem akan membuat ID numerik.
- DESCRIPTION: Deskripsi teks kueri. Opsional.
- PROJECT_ID: ID project.
Jalankan perintah
gcloud logging saved-queries create:Linux, macOS, atau Cloud Shell
gcloud logging saved-queries create --display-name=DISPLAY_NAME \ --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \ --id=ID --description=DESCRIPTION --project=PROJECT_ID
Windows (PowerShell)
gcloud logging saved-queries create --display-name=DISPLAY_NAME ` --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ` --id=ID --description=DESCRIPTION --project=PROJECT_ID
Windows (cmd.exe)
gcloud logging saved-queries create --display-name=DISPLAY_NAME ^ --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^ --id=ID --description=DESCRIPTION --project=PROJECT_ID
Berikut adalah contoh respons saat ID yang diberikan dalam perintah adalah
my-saved-query:Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].
Respons terhadap perintah
createmencantumkan nama lengkap kueri, yang mencakup ID kueri. ID kueri, yang dalam contoh ini adalahmy-saved-query, merupakan input yang diperlukan untuk perintah Google Cloud CLI yang mendeskripsikan, menghapus, atau memperbarui kueri tersimpan. Untuk memeriksa kueri tersimpan, jalankan perintah berikut:
gcloud logging saved-queries list --location=- --project=PROJECT_IDDalam ekspresi sebelumnya, nilai untuk lokasi adalah tanda hubung
(-), yang berfungsi sebagai karakter pengganti. Anda juga dapat memberikan lokasi tertentu.
Ada perintah Google Cloud CLI untuk menghapus, mencantumkan, mendeskripsikan,
dan memperbarui kueri tersimpan. Untuk mengetahui informasi selengkapnya, lihat
Ringkasan gcloud logging saved-queries.
REST
Anda dapat menyimpan kueri menggunakan Cloud Logging API. Untuk menyimpan kueri, gunakan
metode savedQueries.create.
Untuk menjalankan metode ini, lakukan hal berikut:
- Pilih
savedQueries.create. - Di halaman referensi, gunakan APIs Explorer untuk
mengeluarkan perintah. Anda harus menentukan kolom
opsAnalyticsQuery.
Contoh berikut mengilustrasikan contoh isi permintaan, 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 projectGoogle Cloud 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 aneh, Anda mungkin ingin membagikan kueri dan hasilnya kepada rekan satu tim. Saat melihat hasil kueri di halaman Observability Analytics, Anda dapat menyalin URL yang, saat dibuka, menampilkan kueri yang Anda jalankan dan hasilnya.
Untuk membagikan kueri dan hasil kepada rekan satu tim, lakukan hal berikut:
-
Di konsol Google Cloud , buka halaman manage_search Observability Analytics:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.
Isi panel Query dengan kueri, lalu klik Run query.
Anda dapat mengisi panel Query dengan memasukkan kueri baru, dengan memilih kueri dari tab Recent, atau dengan memilih kueri dari tab Saved.
Klik link Bagikan link.
Kirim link ke rekan satu tim Anda.
Saat rekan tim Anda membuka link, halaman Observability Analytics akan terbuka dan menampilkan, tetapi tidak menjalankan, kueri. 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 berhasil membuka URL, peran IAM rekan tim Anda di project Google Cloud harus menyertakan izin yang diperlukan untuk melihat halaman Observability Analytics.
gcloud
Jika Anda ingin membuat kueri tersimpan yang dapat dijalankan oleh orang lain, tetapkan
nilai kolom visibility ke shared:
--visibility=shared
Untuk mengubah visibilitas kueri tersimpan yang ada, gunakan perintah update. Untuk mengetahui informasi selengkapnya tentang perintah yang tersedia, lihat
ringkasan gcloud logging saved-queries.
REST
Anda dapat menggunakan Logging API untuk membuat kueri bersama menggunakan metode savedQueries.create, dan menentukan nilai SHARED di kolom visibility. Untuk informasi selengkapnya, lihat halaman referensi untuk
savedQueries.create.
Melihat dan menjalankan kueri terbaru atau tersimpan
Untuk melihat atau menjalankan ulang kueri, pilih tab Recent di halaman Observability Analytics dan temukan kueri:
- Untuk menjalankan kueri, klik Run.
- Untuk melihat kueri, gunakan opsi di menu more_vert 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_vert More Options.