Menggunakan editor kode untuk MQL

Bagian ini menjelaskan fitur editor kode untuk Bahasa Kueri Monitoring (MQL). Editor tersedia di Konsol Google Cloud dan menyediakan saran, deteksi error, dan dukungan lainnya untuk membuat kueri MQL yang valid.

Halaman ini tidak mencakup bahasa MQL. Untuk serangkaian contoh dan informasi selengkapnya tentang bahasa tersebut, baca Contoh dan Tentang bahasa MQL. Referensi MQL menyediakan referensi yang komprehensif untuk bahasa tersebut.

Mengakses editor kode

Untuk mengakses editor kode saat menggunakan Metrics Explorer, lakukan hal berikut:

1. Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih  Metrics Explorer:

   Buka Metrics Explorer

2. Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah  MQL atau  PromQL.
3. Pastikan MQL dipilih pada tombol Language. Tombol bahasa berada di toolbar yang sama dengan yang memungkinkan Anda memformat kueri.

Anda dapat menggunakan langkah-langkah serupa untuk mengakses editor kode saat membuat diagram di dasbor.

Menggunakan editor kode

Untuk menggunakan editor kode, ketik kueri dalam kotak teks dan klik Run Query:

Pelengkapan otomatis

Saat Anda mengetik kueri, editor akan menampilkan daftar penyelesaian yang valid secara sintaksis. Anda dapat menampilkan menu pelengkapan otomatis secara manual dengan menekan Control+Space, dan Anda dapat menutupnya dengan menekan Escape.

Untuk membuka daftar opsi, gunakan tombol panah. Menekan Enter akan menyisipkan pilihan yang dipilih.

Untuk menyisipkan awalan yang umum ke semua pilihan yang tersedia, tekan Tab.

Pesan error

Pesan error muncul di bagian bawah panel editor.

Jika ada error dalam kueri yang mengganggu saran pelengkapan otomatis, pesan error akan muncul saat Anda mengetik. Jika tidak, pesan error akan muncul saat Anda menjalankan kueri.

Penggabungan kode

Editor menyediakan code folding—kemampuan untuk menciutkan segmen kueri—sehingga Anda dapat menyembunyikannya untuk sementara dari tampilan.

Editor menunjukkan segmen foldable kueri Anda dengan tanda sisipan di samping nomor baris, seperti yang ditunjukkan pada screenshot berikut:

Cari dan ganti

Editor mendukung fitur cari dan ganti. Untuk menemukan, dan jika ingin mengganti istilah dalam kueri Anda, tekan Control+F (atau Command+F di Mac). Screenshot berikut menunjukkan fitur:

Kontrol editor

Editor memiliki dua kontrol yang menentukan cara editor berinteraksi dengan kueri Anda.

Secara default, kueri hanya dijalankan saat Anda mengklik Jalankan Kueri. Anda dapat menyiapkan editor kode untuk otomatis mengeksekusi kueri saat mengetik, tetapi opsi ini dinonaktifkan secara default.

Untuk mengaktifkan opsi jalankan otomatis, gunakan tombol Auto-run. Jika opsi ini diaktifkan, editor berfungsi sebagai berikut:

• Tombol Run Query tidak ditampilkan.
• Pesan error muncul terus-menerus saat Anda mengetik.

• Jika kursor berada di akhir kueri yang tidak lengkap tetapi tidak memiliki error, editor akan menampilkan segitiga kuning di panel kontrol. Jika ada ruang, teks Kueri tidak lengkap juga akan muncul.

  Editor kode tidak mencoba mengevaluasi kueri yang tidak lengkap.

Ada juga Grab-bar antara editor kode dan region diagram. Gunakan batang ini untuk mengubah ukuran relatif kedua wilayah.

Simpan diagram

Dari Metrics Explorer

Dari editor kode di Metrics Explorer, Anda memiliki opsi untuk menyimpan diagram ke dasbor. Untuk menyimpan diagram, lakukan langkah-langkah berikut:

1. Jika opsi eksekusi otomatis tidak diaktifkan, jalankan kueri Anda dengan mengklik Run Query sebelum menyimpan diagram. Jika Anda tidak menjalankan kueri terlebih dahulu, editor kode akan menyimpan kueri terakhir yang Anda jalankan.

2. Klik Save Chart. Kotak dialog memberi tahu Anda bahwa menyimpan diagram akan mengganti kueri dengan formulir ketat. Untuk informasi selengkapnya, lihat Kueri formulir ketat.

3. Untuk terus menyimpan diagram:

   1. Berikan judul deskriptif pada diagram.
   2. Pilih dasbor yang diinginkan untuk diagram baru.
   3. Klik Simpan pada dialog.

Dari dasbor

Untuk menyimpan diagram yang Anda tambahkan ke dasbor, lakukan tindakan berikut:

1. Berikan judul deskriptif pada diagram.

2. Jika opsi eksekusi otomatis tidak diaktifkan, jalankan kueri Anda dengan mengklik Run Query sebelum menyimpan diagram. Jika Anda tidak menjalankan kueri terlebih dahulu, editor kode akan menyimpan kueri terakhir yang Anda jalankan.

3. Klik Simpan. Kotak dialog memberi tahu Anda bahwa menyimpan diagram akan mengganti kueri dengan formulir ketat. Untuk informasi selengkapnya, lihat Kueri formulir ketat.

4. Klik Simpan pada dialog untuk menyimpan diagram dan kembali ke dasbor.

Keluar dari editor kode

Untuk keluar dari editor kode tanpa menyimpan diagram atau kondisi, klik Kembali ke widget pemilih kueri. Teks kueri apa pun di editor akan dibuang, tetapi Anda diberi opsi untuk menyimpannya ke {i>clipboard<i}.

Lihat kueri dalam bentuk ketat

Untuk melihat kueri dalam formulir ketat saat menggunakan editor kode, klik Opsi lainnya, lalu pilih Lihat formulir ketat.

Untuk informasi selengkapnya, lihat Kueri formulir ketat.

Rentang waktu, diagram, dan editor kode

Kecuali untuk kueri MQL yang digunakan dalam kondisi untuk kebijakan pemberitahuan, kueri MQL di editor kode harus menyertakan rentang waktu. Rentang waktu menentukan subset data yang akan ditampilkan sebagai bagian dari kueri. Rentang waktu dapat dinyatakan secara implisit menggunakan pemilih rentang waktu diagram atau secara eksplisit dalam teks kueri MQL Anda.

Secara default, pemilih rentang waktu disetel ke satu jam.

Untuk mengubah rentang waktu diagram, gunakan pemilih rentang waktu. Misalnya, jika Anda ingin melihat data selama seminggu terakhir, pilih 1 minggu terakhir dari pemilih rentang waktu. Anda juga dapat menentukan waktu mulai dan berakhir, atau menentukan waktu untuk melihatnya.

Untuk mengetahui informasi tentang cara membuat kebijakan pemberitahuan dengan editor kode, lihat Membuat kebijakan pemberitahuan MQL.

Menggunakan setelan diagram untuk pilihan waktu

Anda dapat mengatur jangka waktu untuk kueri dengan menggunakan pemilih waktu diagram. Pemilih ini adalah cara default untuk menyetel jangka waktu. Untuk mengubah jangka waktu, pilih opsi waktu yang berbeda di diagram. Jika Anda memilih, misalnya, satu minggu, kueri akan menampilkan data dari sekarang hingga seminggu yang lalu.

Saat menggunakan mekanisme default ini, Anda tidak perlu menentukan rentang waktu eksplisit dalam teks kueri. Nilai pada diagram digunakan secara implisit.

Menggunakan within untuk pemilihan waktu

Anda dapat menentukan rentang waktu untuk kueri secara eksplisit dalam kueri menggunakan operasi within. Operasi ini menentukan rentang data yang ditampilkan. Jika kueri Anda menyertakan operasi within, opsi pemilihan waktu pada diagram akan dinonaktifkan dan rentang waktu yang ditentukan dalam kueri akan digunakan.

Jika Anda menghapus operasi within eksplisit dari kueri, opsi diagram akan otomatis diaktifkan kembali, sehingga memastikan kueri Anda selalu menyertakan jangka waktu.

Anda harus menggunakan pemilihan waktu eksplisit jika ingin menggunakan metode API timeSeries.query untuk mengeluarkan kueri. Untuk mengetahui informasi selengkapnya, lihat Menggunakan MQL dari Monitoring API.

Setelan waktu dan diagram tersimpan

Jika Anda menggunakan MQL untuk membuat diagram, lalu menyimpan diagram tersebut ke dasbor, ada dua hal yang terjadi pada kueri Anda:

1. Kueri yang Anda berikan di editor dikonversi menjadi formulir kanonis atau ketat. Konversi tidak mengubah arti kueri Anda, tetapi menghasilkan hal-hal eksplisit yang diasumsikan dalam kueri, seperti nama kolom lengkap atau operasi penyelarasan. Untuk informasi selengkapnya, lihat Kueri formulir ketat.

2. Pilihan rentang waktu dalam kueri Anda akan dihapus. Diagram di dasbor menggunakan pemilih waktu, dan perubahan pada pemilih tersebut berlaku untuk semua diagram di dasbor. Oleh karena itu, pemilih rentang waktu dari kueri asli tidak lagi diperlukan.

Untuk informasi tentang cara mengelola dasbor dan mengedit diagram, lihat Mengelola dasbor kustom.

Periode kueri, perataan, dan tampilan

MQL memiliki sejumlah operasi yang berpotensi membingungkan dan menentukan jangka waktu. Operasi berikut terkait dengan rentang kueri:

• within: menentukan jendela kueri-output. Operasi ini menentukan jumlah data yang ditampilkan. Misalnya, jika Anda menentukan within 1h, kueri hanya akan menghasilkan titik yang stempel waktunya berada dalam satu jam terakhir. Itulah sebabnya operasi ini mengganti opsi pemilih waktu diagram.

• Operasi berikut berhubungan dengan periode penyelarasan tabel output-nya. Keduanya memerlukan tabel yang disejajarkan sebagai input, atau keduanya menyediakan default:

  • every: menentukan periode untuk output tabel yang diselaraskan.

  • window: menentukan jendela untuk operasi penyelarasan.

  Dalam kedua kasus tersebut, jika operasi align disediakan dengan jendela perataan eksplisit, operasi tersebut harus cocok dengan periode yang ditentukan untuk operasi window, jika disediakan. Untuk fungsi penyelarasan delta, periode dan periode penyelarasan harus sama; jika jendela penyelarasan eksplisit diberikan, operasi every, jika diberikan, harus setuju. Dalam semua kasus, jendela penyelarasan minimal harus sebesar periode penyelarasan atau data input akan diabaikan.

MQL juga memiliki operasi graph_period, yang menentukan periode titik output untuk diagram. Operasi ini berguna dalam kueri yang diberikan ke API yang output-nya digambarkan oleh software pihak ketiga. Software diagram Monitoring mengabaikan operasi graph_period dalam kueri, yang menetapkan periode titik sesuai dengan lebar waktu diagram output.

Dalam diagram Monitoring, periode grafik ditetapkan berdasarkan nilai pemilih rentang waktu diagram dan jumlah maksimum titik yang dapat ditampilkan diagram. Misalnya, jika Anda memilih satu minggu, periode grafik mungkin satu jam. Untuk diagram di dasbor, untuk melihat periode grafik, klik Statistik kueri.

Hubungan antara periode penyelarasan kueri dan periode grafik dapat mengubah tampilan diagram. Hubungan ini dijelaskan di bagian berikut.

Tali min/maks

Saat periode penyelarasan kueri mendekati periode grafik, diagram akan mewakili setiap deret waktu yang dibuat dalam grafik dengan satu baris. Jika periode perataan kueri kurang dari setengah periode grafik diagram, diagram akan menyertakan area berarsir di sekitar setiap garis. Wilayah ini, yang disebut band min/maks, menunjukkan rentang nilai yang menghasilkan nilai rata-rata.

Misalnya, asumsikan kueri MQL sederhana berikut:

fetch gce_instance::compute.googleapis.com/instance/cpu/utilization
| group_by [zone], mean(val())
| every 1h

Kueri ini menampilkan rata-rata penggunaan CPU VM menurut zona, dengan periode penyelarasan satu jam.

Jika pemilih waktu diagram ditetapkan ke satu minggu, periode grafik adalah satu jam, yang ditunjukkan pada chip. Untuk contoh kueri, periode grafik dan periode penyelarasan adalah sama. Menjalankan kueri akan menghasilkan diagram yang terlihat seperti berikut:

Misalnya, jika Anda mengubah periode perataan yang diteruskan ke operasi every dari 1h menjadi 1m pada kueri sebelumnya, kueri tersebut akan menghasilkan diagram yang menyertakan band min/maks:

Garis diagram ditampilkan dalam grafik periode grafik selama satu jam, berdasarkan pilihan satu minggu untuk diagram, sehingga garisnya sama dengan garis di contoh sebelumnya. Namun, kueri ini menghasilkan satu titik setiap menit, sehingga band min/maks menampilkan rentang nilai satu menit dari kueri yang termasuk dalam setiap titik grafik satu jam.

Jika operasi every dihilangkan, periode penyelarasan kueri default adalah nilai jendela penyelarasan atau, jika periode penyelarasan tidak ditentukan, satu menit.

Kebijakan pemberitahuan berbasis MQL

Anda juga dapat menggunakan MQL dan editor kode untuk membuat kueri yang akan digunakan dalam kebijakan pemberitahuan.

Untuk membuat kebijakan pemberitahuan berbasis MQL dari Konsol Google Cloud, ikuti langkah-langkah pembuatan kebijakan seperti biasa, seperti yang dijelaskan dalam Mengelola kebijakan pemberitahuan. Namun, saat membuat kondisi untuk kebijakan pemberitahuan, Anda menggunakan editor kode, bukan pemilih metrik berbasis formulir.

Untuk mengetahui informasi selengkapnya, lihat Membuat kebijakan pemberitahuan MQL.

Konversi kueri

Anda dapat menggunakan pemilih metrik untuk diagram atau di Metrics Explorer untuk membuat kueri, lalu mengonversi kueri tersebut menjadi MQL. Kueri MQL yang sesuai akan ditampilkan di editor.

Untuk mengonversi kueri yang dibuat menu menjadi MQL, saat menggunakan Metrics Explorer, lakukan hal berikut:

1. Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah  MQL atau  PromQL.
2. Pastikan MQL dipilih pada tombol Language. Tombol bahasa berada di toolbar yang sama dengan yang memungkinkan Anda memformat kueri.

Untuk mengonversi kueri berbasis formulir menjadi MQL, saat melihat diagram di dasbor, klik MQL.

Pertimbangkan permintaan yang sangat sederhana, seperti "Dapatkan penggunaan CPU dari instance VM Compute Engine saya". Kueri ini melibatkan jenis resource yang dimonitor gce_instance dan jenis metrik compute.googleapis.com/instance/cpu/usage_time.

Screenshot berikut menampilkan kueri ini dalam pemilih metrik berbasis formulir:

Metrik dan jenis resource yang dipantau dimasukkan secara manual. Semua kolom lain memiliki nilai defaultnya.

Screenshot berikut menunjukkan hasil dari konversi pemilihan berbasis formulir menjadi kueri MQL:

Kueri MQL mengambil deret waktu untuk metrik dan jenis resource yang ditentukan, serta melakukan penyelarasan kecepatan dalam interval 1 menit. Kueri yang dikonversi menggunakan format ketat.

Catatan: Anda tidak dapat mengonversi representasi MQL kembali ke setelan di pemilih metrik berbasis formulir. MQL mendukung kueri yang tidak dapat Anda build dengan pemilih metrik. Saat Anda keluar dari editor kode, teks kueri akan dihapus jika Anda tidak menyimpannya.