Anda dapat menyimpan dan membagikan kueri SQL di Observability Analytics, yang memungkinkan Anda menjalankan kembali investigasi yang sering dilakukan dan berkolaborasi dengan anggota tim di seluruh project Anda. Kueri tersimpan dapat disimpan secara pribadi untuk penggunaan Anda sendiri atau dibagikan kepada anggota project lainnya. Jika Anda belum menulis kueri di Observability Analytics, lihat terlebih dahulu Membuat kueri dan menganalisis telemetri dengan Observability Analytics.
Sebelum memulai
Konfigurasi project, peran IAM, dan pilih antarmuka yang akan Anda gunakan.
Mengonfigurasi project dan peran
- 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.
-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Observability API.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Observability API.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
Untuk mendapatkan izin yang diperlukan untuk memuat halaman Observability Analytics, menulis, menjalankan, dan menyimpan kueri pribadi, minta administrator untuk memberi Anda peran IAM berikut:
- Pengakses Lihat Observabilitas (
roles/observability.viewAccessor) pada tampilan observabilitas yang ingin Anda kueri. Peran ini mendukung kondisi IAM, yang memungkinkan Anda membatasi pemberian ke tampilan tertentu. Jika Anda tidak melampirkan kondisi ke pemberian peran, akun utama dapat mengakses semua tampilan observabilitas. - Pengguna Observability Analytics (
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.
- Pengakses Lihat Observabilitas (
Memilih antarmuka yang akan Anda gunakan
Konsol
Saat menggunakan Google Cloud konsol untuk mengakses Google Cloud layanan dan API, Anda tidak perlu menyiapkan autentikasi.
gcloud
Di Google Cloud konsol, aktifkan Cloud Shell.
Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan prompt command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.
REST
Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.
Instal Google Cloud CLI.
Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam Google Cloud dokumentasi autentikasi.
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.
Untuk menggunakan kembali kueri, menambahkan deskripsi kustom, atau membagikannya kepada rekan tim, 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:
-
Di Google Cloud konsol, 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, 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, tombol Simpan akan diaktifkan.
Klik Simpan, pilih Simpan kueri, dan isi kolom Nama dan Deskripsi. Nilai yang Anda tetapkan untuk kolom ini ditampilkan di tab Tersimpan.
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.
Klik Simpan kueri.
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 dibuat menggunakan opsi di tab Tersimpan:
Untuk mengedit kueri, klik more_vert 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 more_vert Opsi Lainnya , lalu pilih Hapus.
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
privateataushared. - SQL_QUERY: Kueri SQL. Jika tanda petik terbalik tunggal
(`)mengapit jalur atau kolom dalam jalur, Anda harus meng-escape tanda petik terbalik tersebut:"SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"atau
"SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"Tanda petik terbalik
(`)diperlukan jika elemen jalur berisi karakter titik(.)karakter. - ID: ID kueri tersimpan. ID ini adalah input yang diperlukan untuk perintah yang menjelaskan, 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, adalah input yang diperlukan untuk perintah Google Cloud CLI yang menjelaskan, 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 a tanda hubung
(-), yang berfungsi sebagai karakter pengganti. Anda juga dapat memberikan lokasi tertentu.
Ada perintah Google Cloud CLI untuk menghapus, mencantumkan, menjelaskan, dan memperbarui kueri tersimpan. Untuk mengetahui informasi selengkapnya, lihat
gcloud logging saved-queries ringkasan.
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 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 hasilnya kepada rekan tim, lakukan hal berikut:
-
Di Google Cloud konsol, 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, memilih kueri dari tab Terbaru, atau memilih kueri dari tab Tersimpan.
Klik link Bagikan link.
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.
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
gcloud logging saved-queries ringkasan.
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 more_vert 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 more_vert Opsi Lainnya.