Dokumen ini menjelaskan cara menyematkan filter tingkat dasbor sehingga filter ini bersifat permanen. Filter yang disematkan—yang memungkinkan Anda mengubah data yang ditampilkan oleh dasbor tanpa harus mengubah setiap widget—memiliki status default dan berlaku untuk seluruh dasbor. Toolbar dasbor menampilkan setiap filter yang disematkan, beserta menu yang memungkinkan Anda mengubah nilai filter untuk sementara.
Variabel mirip dengan filter yang disematkan, tetapi hanya berlaku untuk widget tertentu. Dokumen ini menjelaskan cara membuat variabel dan cara menerapkannya dengan widget. Variabel dapat mengubah kueri widget atau dapat mengontrol visibilitas widget. Toolbar dasbor menampilkan
setiap variabel berdasarkan nama, beserta menu, yang memungkinkan Anda mengubah
nilai variabel untuk sementara. Untuk membantu Anda membedakan filter dari variabel,
di toolbar, nama variabel diawali dengan tanda dolar $
.
Dokumen ini menjelaskan cara menggunakan konsol Google Cloud untuk membuat variabel dan filter yang disematkan. Untuk mengetahui informasi tentang penggunaan Cloud Monitoring API, lihat Membuat dan mengelola dasbor menggunakan API: Filter dasbor.
Untuk mengetahui informasi tentang cara menambahkan dan mengubah pengelompokan dan filter sementara, yang hanya berlaku untuk sesi saat ini, lihat Menambahkan filter sementara ke dasbor kustom.
Fitur ini hanya didukung untuk Google Cloud project. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
Tentang filter yang disematkan
Filter yang disematkan berisi label, satu atau beberapa nilai default, dan
daftar semua kemungkinan nilai. Daftar semua kemungkinan nilai diturunkan secara dinamis dari data deret waktu yang ditampilkan di dasbor Anda.
Untuk mengetahui informasi tentang struktur filter, lihat DashboardFilter
.
Anda tidak menerapkan filter yang disematkan ke setiap widget. Sebagai gantinya, aturan berikut digunakan untuk menentukan apakah filter yang disematkan dapat mengubah data yang ditampilkan oleh widget:
Jika widget menampilkan data yang menyertakan kunci label yang ditentukan oleh filter tersemat dan jika widget tidak menentukan nilai untuk kunci label tersebut, maka filter tersemat dapat mengubah data yang ditampilkan.
Misalnya, Anda menambahkan filter yang disematkan cluster_name: mycluster. Kemudian, diagram akan otomatis menampilkan hanya deret waktu yang memiliki label cluster_name dengan nilai mycluster. Demikian pula, kueri pada widget panel log Anda diubah menjadi resource.labels."cluster_name"="mycluster", dan diagram Anda otomatis menampilkan hanya deret waktu yang menyertakan label dalam filter yang disematkan.
Filter yang disematkan diabaikan oleh widget saat widget menyertakan filter untuk kunci label yang sama, atau saat data yang ditampilkan oleh widget tidak berisi kunci label yang ditentukan dalam filter yang disematkan.
Tentang variabel
Variabel memiliki nama dan jenis. Variabel diterapkan ke widget tertentu
dengan mengubah kueri yang ada di widget tersebut.
Untuk mengetahui informasi tentang struktur filter, lihat DashboardFilter
.
Di toolbar dasbor, nama variabel diawali dengan tanda dolar $
.
Jika Anda juga melihat ikon visibility Terlihat, berarti variabel
mengontrol visibilitas setidaknya satu widget.
Variabel dapat berbasis label atau hanya memiliki nilai:
Variabel berbasis label seperti filter yang disematkan. Variabel ini berisi kunci label, satu atau beberapa nilai label default, dan daftar semua kemungkinan nilai label. Daftar semua kemungkinan nilai diturunkan secara dinamis dari data deret waktu yang ditampilkan di dasbor Anda.
Variabel hanya nilai berisi satu atau beberapa nilai default, dan mungkin mencantumkan semua kemungkinan nilai. Jika Anda tidak menentukan nilai default, maka operator wildcard,
(*)
, akan dipilih untuk nilai default. Untuk menentukan kumpulan semua kemungkinan nilai, Anda dapat memberikan array nilai atau menulis kueri SQL.Ada tiga jenis variabel hanya nilai: Kustom, Input Teks, dan Kueri SQL.
Kustom: Gunakan jika Anda ingin mencantumkan daftar semua kemungkinan nilai dan juga menetapkan satu atau beberapa nilai default. Misalnya, Anda dapat menetapkan daftar semua nilai yang mungkin ke
prod, staging, dev
, dan menetapkan nilai default keprod
.Input Teks: Gunakan jika Anda tidak mengetahui semua kemungkinan nilai. Misalnya, Anda mungkin ingin memfilter menurut URL, tetapi saat membuat variabel, Anda tidak mengetahui daftar URL yang tepat. Kemudian, saat menggunakan menu filter untuk widget, Anda dapat memasukkan URL baru, lalu menyimpan perubahan untuk sesi saat ini atau ke definisi variabel.
Kueri SQL: Gunakan saat Anda ingin membuat daftar kemungkinan nilai menggunakan kueri SQL. Variabel ini dimaksudkan untuk diterapkan ke diagram yang dibuat menggunakan Log Analytics.
Untuk variabel ini, pastikan hasil kueri adalah tabel dengan satu kolom, jenis data kolom tersebut adalah string, dan setiap baris dalam tabel berisi nilai string unik:
SELECT log_name FROM `TABLE_NAME_OF_LOG_VIEW` GROUP BY log_name
Kueri SQL tidak dapat bergantung pada variabel.
Untuk menerapkan variabel ke widget, Anda dapat memperbarui kueri yang dikeluarkan oleh widget atau memperbarui visibilitas widget. Anda dapat mengedit widget kapan saja untuk memperbarui kuerinya. Namun, untuk variabel berbasis label dan beberapa jenis widget, Anda dapat memperbarui kueri dengan memilih menu. Untuk mengontrol visibilitas, Anda harus mengedit widget. Untuk mengetahui informasi selengkapnya, lihat bagian berikut dalam dokumen ini:
Sebelum memulai
Selesaikan langkah-langkah berikut untuk project Google Cloud tempat Anda ingin mengonfigurasi filter dan variabel:
-
Untuk mendapatkan izin yang diperlukan untuk menambahkan atau mengubah variabel atau filter yang disematkan menggunakan konsol Google Cloud , minta administrator Anda untuk memberi Anda peran IAM Monitoring Editor (
roles/monitoring.editor
) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Untuk mengetahui informasi selengkapnya tentang peran, lihat Mengontrol akses dengan Identity and Access Management.
Membuat dan menyematkan filter
Untuk membuat dan menyematkan filter yang berlaku untuk semua widget dasbor yang mendukung filter, lakukan tindakan berikut:
-
Di konsol Google Cloud , buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
- Pilih dasbor, buka toolbar dasbor, lalu klik settings Setelan.
- Di bagian Filter, klik Add a filter.
- Klik arrow_drop_down Label, lalu pilih label. Misalnya, Anda dapat memilih
zone
. - Untuk mengizinkan pengguna memilih beberapa nilai dari menu nilai variabel, pilih Pilihan ganda. Jika Pilihan ganda tidak diaktifkan, pengguna hanya dapat memilih satu opsi dari menu nilai.
Klik arrow_drop_down Nilai default, lalu pilih nilai default untuk label. Untuk mencocokkan semua nilai, pilih
*
.Setelah dibuat, filter akan ditambahkan ke toolbar dasbor Anda. Untuk mengubah nilai filter untuk sementara, pilih filter, lalu buat pilihan dari menu.
Klik Selesai, lalu Terapkan.
Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
Buat variabel
Untuk membuat variabel yang berlaku untuk widget dasbor tertentu, lakukan hal berikut:
-
Di konsol Google Cloud , buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
- Pilih dasbor, buka toolbar dasbor, lalu klik settings Setelan.
- Di bagian Variabel, klik Tambahkan variabel.
Pilih jenis variabel, lalu selesaikan dialog.
Untuk membuat variabel berbasis label, pilih Label. Gunakan opsi ini jika Anda ingin variabel yang memiliki kunci label dan nilai label, dan yang dapat digunakan seperti filter. Daftar semua kemungkinan nilai diturunkan secara dinamis dari data deret waktu yang ditampilkan di dasbor Anda. Menu Terapkan ke diagram memungkinkan Anda memilih widget yang kuerinya akan diubah oleh variabel. Anda juga dapat memperbarui kueri dengan mengedit widget.
Untuk variabel khusus nilai, Anda memiliki opsi berikut:
SQL: Gunakan opsi ini jika Anda ingin hasil kueri SQL membuat daftar semua kemungkinan nilai.
Masukkan satu atau beberapa nilai default, lalu masukkan kueri SQL yang membuat daftar semua nilai yang mungkin. Pastikan hasil kueri adalah tabel dengan satu kolom, jenis data kolom tersebut adalah string, dan setiap baris dalam tabel berisi nilai string unik.
Kustom: Gunakan opsi ini jika Anda ingin menentukan daftar kemungkinan nilai dan nilai default. Misalnya, Anda dapat menetapkan kolom Nilai ke
prod, staging, dev
, dan menetapkan Nilai default keprod
.Input Teks: Gunakan opsi ini jika Anda ingin menentukan daftar nilai yang diterapkan sebagai default.
Klik Selesai, lalu Terapkan.
Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
Terapkan variabel ke widget. Jika Anda memperbarui kueri widget, maka saat Anda mengubah nilai variabel, kueri akan diubah dan data yang ditampilkan widget akan diubah. Anda juga dapat menggunakan variabel untuk mengontrol apakah widget terlihat atau tidak. Untuk mengetahui informasi selengkapnya, lihat bagian berikut dalam dokumen ini:
Menetapkan visibilitas widget
Saat widget membuat kueri data, Anda dapat menggunakan variabel untuk mengontrol apakah widget terlihat di dasbor. Misalnya, anggaplah dasbor berisi widget yang menampilkan data untuk sistem produksi Anda dan kumpulan widget lain yang menampilkan data untuk sistem staging Anda. Saat men-debug selama pengembangan, Anda mungkin hanya ingin melihat data penyiapan. Dengan mengonfigurasi visibilitas widget dasbor dengan variabel, Anda dapat beralih antara hanya data produksi, hanya data penyiapan, dan semua data.
Semua jenis variabel dapat mengontrol apakah widget terlihat atau tersembunyi.
Untuk mengonfigurasi visibilitas widget, lakukan hal berikut:
-
Di konsol Google Cloud , buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Pilih dasbor.
- Buka toolbar widget yang visibilitasnya ingin Anda konfigurasi, lalu klik edit Edit.
- Di panel Display, luaskan Widget visibility.
Pilih variabel dan lengkapi dialog.
Klik Selesai, lalu Terapkan.
Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
Dasbor dimuat ulang. Jika setidaknya satu widget di dasbor disembunyikan karena kontrol visibilitas, dasbor akan menampilkan banner. Untuk melihat semua widget, klik Tampilkan semua widget.
Saat Anda menggunakan variabel untuk mengontrol visibilitas setidaknya satu widget di dasbor, di toolbar, nama variabel diberi anotasi dengan ikon visibility Terlihat.
Batasan
Batasan berikut berlaku saat mengonfigurasi visibilitas widget:
Widget organisasi seperti grup yang dapat diciutkan, header bagian, dan widget tampilan tunggal selalu terlihat.
Anda dapat menghapus variabel yang direferensikan oleh kontrol visibilitas widget. Tindakan penghapusan variabel juga menghapus referensi apa pun ke variabel.
Tidak semua dasbor mendukung pembuatan variabel. Namun, jika dasbor berisi variabel, Anda dapat menggunakan variabel tersebut untuk mengelola visibilitas widget di dasbor.
Memperbarui kueri widget
Bagian ini menjelaskan cara menyertakan variabel dalam kueri yang dikeluarkan widget. Akibatnya, saat Anda mengubah nilai variabel, kueri akan diubah dan data yang ditampilkan widget akan diubah:
Untuk diagram yang menggunakan kueri SQL, PromQL, atau MQL, dan untuk widget panel log, Anda harus mengedit widget dan mengubah kueri. Bagian ini menjelaskan cara melakukan pengeditan tersebut.
Untuk diagram yang Anda konfigurasi menggunakan menu atau menggunakan mode filter langsung, Monitoring mengedit kueri saat Anda memilih widget menggunakan menu Terapkan ke diagram. Sebagai alternatif, Anda dapat mengedit widget, membuka kolom Filter, lalu memilih variabel.
Untuk mempelajari cara memperbarui kueri widget dengan variabel berbasis label atau variabel hanya nilai, lihat bagian berikut:
- Sintaksis umum untuk menghilangkan referensi variabel
- Widget panel log
- Diagram dengan kueri PromQL
- Diagram dengan kueri SQL
- Diagram dengan kueri MQL
Diagram dengan kueri filter Monitoring
Saat Anda menggunakan antarmuka berbasis menu untuk membuat diagram yang menampilkan data deret waktu, pilihan Anda akan dikonversi menjadi filter Monitoring.
Membuat filter dan variabel
Konsol
Untuk mengetahui informasi tentang cara menggunakan konsol Google Cloud untuk membuat filter dan variabel yang disematkan, lihat dokumen berikut:
API
Untuk menentukan filter dan variabel yang disematkan, gunakan struktur data
dashboardFilters
.
- Untuk membuat variabel, tetapkan nilai kolom
templateVariable
ke nama variabel. Hapus kolom ini atau tetapkan nilai ke string kosong jika Anda ingin membuat filter yang disematkan. - Untuk membuat filter yang disematkan atau variabel berbasis label, Anda harus menentukan kolom
labelKey
. Hapus kolom ini jika Anda menginginkan variabel khusus nilai. Tetapkan nilai default untuk filter atau variabel. Konfigurasi kolom ini menentukan apakah pengguna dapat memilih tepat satu opsi dari menu nilai, atau apakah mereka dapat memilih beberapa nilai.
- Untuk menetapkan satu nilai default dan membatasi pengguna agar memilih tepat
satu opsi di menu nilai, tetapkan kolom
valueType
sebagaiSTRING
dan tetapkan juga kolomstringValue
:
"valueType": "STRING", "stringValue": "my-default-value",
- Untuk menetapkan setidaknya satu nilai default dan mengizinkan pengguna memilih beberapa opsi di menu nilai, tetapkan kolom
valueType
sebagaiSTRING_ARRAY
dan tetapkan juga kolomstringArrayValue
. Dalam contoh berikut, ada tiga nilai default.
"valueType": "STRING_ARRAY", "stringArrayValue": { "values": [ "a", "b", "c" ] },
- Untuk menetapkan satu nilai default dan membatasi pengguna agar memilih tepat
satu opsi di menu nilai, tetapkan kolom
Opsional: Untuk menentukan daftar semua nilai yang mungkin untuk variabel hanya nilai, tetapkan kolom
stringArray
atau kolomtimeSeriesQuery
. Jika Anda menentukan kueri, kueri tersebut harus berupa kueri analisis.
Misalnya, pertimbangkan objek dashboardFilters
berikut:
{ "dashboardFilters": [ { "labelKey": "zone" "stringValue": "us-central1-c", "valueType": "STRING", "filterType": "RESOURCE_LABEL" }, { "labelKey": "instance_id", "stringValue": "3133577226154888113", "valueType": "STRING", "filterType": "RESOURCE_LABEL", "templateVariable": "my_label_based_variable" }, { "filterType": "VALUE_ONLY", "templateVariable": "my_value_only_variable", timeSeriesQuery: { opsAnalyticsQuery: { sql: " SELECT log_name FROM `MY_TABLE` GROUP BY log_name ", } } } ], "displayName": "Illustrate Variables", ... }
JSON sebelumnya menentukan satu filter yang disematkan dan dua variabel:
Filter yang disematkan memiliki kunci label
zone
, yang ditampilkan di toolbar. KolomvalueType
danstringValue
menentukan nilai default tunggal. Untuk mengetahui informasi selengkapnya, lihat halaman referensi API untuk struktur datadashboardFilters
.Variabel berbasis label memiliki nama
my_label_based_variable
, dan kunci labelnya adalahinstance_id
. Nilai default untuk variabel ini ditetapkan ke ID instance tertentu. Anda juga dapat mengonfigurasi nilai default menggunakan array. Di toolbar, filter ditampilkan dengan namamy_label_based_variable
.Variabel khusus nilai diberi nama
my_value_only_variable
. Entri ini tidak menentukan nilai default, sehingga operator wildcard,(*)
, diterapkan secara otomatis. Selain itu, variabel ini menggunakan kueri SQL untuk membuat daftar kemungkinan nilai untuk variabel.
Perhatikan bahwa objek dashboardFilters
tidak mencantumkan widget tempat
variabel diterapkan. Sebagai gantinya, Anda memperbarui kueri widget agar bergantung pada
variabel.
Sintaksis umum untuk menghilangkan referensi variabel
Untuk semua widget, kecuali yang ditentukan oleh SQL, gunakan sintaksis berikut untuk menerapkan variabel ke kueri:
Untuk menerapkan variabel berbasis label dan membuat kunci label serta nilai label diselesaikan menjadi ekspresi filter yang valid untuk bahasa kueri, gunakan
${my_label_based_variable}
.Untuk menerapkan hanya nilai variabel berbasis label, gunakan
${my_label_based_variable.value}
. Perbandingan harus menggunakan regular expression.Untuk menerapkan hanya nilai variabel khusus nilai, gunakan
${my_value_only_variable}
. Untuk variabel khusus nilai, jangan sertakan klausa.value
. Perbandingan harus menggunakan regular expression.
Widget panel log
Untuk menerapkan variabel ke widget panel log, perbarui panel kueri. Sintaksis untuk widget ini mengikuti sintaksis yang ditentukan di bagian Sintaksis umum.
Konsol
Misalnya, kueri berikut menggunakan ekspresi reguler untuk membandingkan
nilai kolom jsonPayload.message
dengan nilai string yang menyertakan
nilai variabel berbasis label:
jsonPayload.message=~"Connected to instance: ${my_label_based_variable.value}"
Sebagai contoh lain, pertimbangkan variabel khusus nilai,
value_only_severity_variable
, dan asumsikan bahwa dalam menu nilai, tiga
nilai dipilih: ERROR
, INFO
, dan NOTICE
.
Selanjutnya, Anda menambahkan kode berikut ke widget panel log di panel kueri:
severity =~ "${value_only_severity_variable}"
Berikut adalah ilustrasi formulir yang dirender:
severity =~ "^(ERROR|INFO|NOTICE)$"
API
Misalnya, JSON berikut menggambarkan cara memperbarui kueri widget panel log dengan variabel berbasis label:
"logsPanel": { "filter": "${my_label_based_variable}", "resourceNames": [ "projects/1234512345" ] },
Misalnya, kueri berikut menggunakan ekspresi reguler untuk membandingkan
nilai kolom jsonPayload.message
dengan nilai string yang menyertakan
nilai variabel berbasis label:
"logsPanel": { "filter": "resource.type=\"gce_instance\"\n resource.labels.project_id=~\"${my_label_based_variable.value}\"\n", "resourceNames": [ "projects/012345" ] }
Sebagai contoh lain, pertimbangkan variabel khusus nilai,
value_only_severity_variable
, dan asumsikan bahwa tiga
nilai dipilih dalam menu: ERROR
, INFO
, dan NOTICE
.
Selanjutnya, Anda menambahkan kode berikut ke widget panel log di panel kueri:
"logsPanel": {
"filter": "severity =~ \"${value_only_severity_variable}\"\n",
...
}
Berikut ini mengilustrasikan kueri yang dieksekusi oleh widget panel log:
severity =~ "^(ERROR|INFO|NOTICE)$"
Jika Anda telah mengonfigurasi kueri untuk panel log, lalu memilih tombol untuk membuka Logs Explorer, variabel akan diselesaikan sebelum Logs Explorer dibuka.
Tabel berikut menggambarkan cara variabel contoh diselesaikan oleh panel log. Seperti yang disebutkan sebelumnya, jika hanya nilai variabel yang digunakan, Anda harus menggunakan ekspresi reguler sebagai operator perbandingan:
Sintaks | Nilai Yang Dipilih |
Ekspresi panel log yang diselesaikan |
---|---|---|
${my_label_based_variable} |
12345 |
resource.labels."instance_id"="12345"
Variabel contoh didasarkan pada label resource
|
${my_label_based_variable} |
* |
"" |
${my_label_based_variable.value} ${my_value_based_variable} |
12345 |
12345 |
${my_label_based_variable.value} ${my_value_based_variable} |
* |
.* |
Diagram dengan kueri PromQL
Untuk memperbarui diagram yang memiliki kueri PromQL agar bergantung pada variabel berbasis label, ikuti panduan yang tercantum di Sintaksis umum.
Konsol
Misalnya, kueri berikut mengandalkan variabel berbasis label, my_label_based_variable
, yang diselesaikan menjadi ekspresi filter:
compute_googleapis_com:instance_cpu_utilization{ monitored_resource="gce_instance", ${my_label_based_variable} }
Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel.
Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai
kueri berbasis label dengan instance_id
:
compute_googleapis_com:instance_cpu_utilization{ instance_id=~"${my_label_based_variable.value}" }
Jika Anda memiliki variabel khusus nilai, hapus klausa .value
. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:
zone=~"${my_value_only_variable}"
API
Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable
, yang diselesaikan menjadi ekspresi filter:
"timeSeriesQuery": { "prometheusQuery": "avg_over_time( compute_googleapis_com:instance_cpu_utilization{ monitored_resource=\"gce_instance\", ${my_label_based_variable} }[${__interval}])", "unitOverride": "", "outputFullDuration": false },
Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel.
Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai
kueri berbasis label dengan instance_id
:
"timeSeriesQuery": { "prometheusQuery": "avg_over_time( compute_googleapis_com:instance_cpu_utilization{ monitored_resource=\"gce_instance\", instance_id=~\"${my_label_based_variable.value}\" }[${__interval}])", "unitOverride": "", "outputFullDuration": false },
Jika Anda memiliki variabel khusus nilai, hapus klausa .value
. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:
zone=~\"${my_value_only_variable}\"
Tabel berikut menggambarkan cara variabel contoh diselesaikan oleh PromQL. Seperti yang disebutkan sebelumnya, jika hanya nilai variabel yang digunakan, Anda harus menggunakan ekspresi reguler sebagai operator perbandingan:
Sintaks | Nilai Yang Dipilih |
Ekspresi PromQL yang diselesaikan |
---|---|---|
${my_label_based_variable} |
12345 |
instance_id == '12345'
Variabel contoh didasarkan pada label resource
|
${my_label_based_variable} |
* |
noop_filter=~".*" |
${my_label_based_variable.value} ${my_value_based_variable} |
12345 |
12345 |
${my_label_based_variable.value} ${my_value_based_variable} |
* |
.+ |
Diagram dengan kueri SQL
Jika Anda ingin memperbarui widget yang ditentukan SQL agar bergantung pada variabel,
perbarui klausa WHERE
untuk mereferensikan nilai variabel.
Untuk semua variabel, tambahkan awalan tanda "at" pada nama variabel, misalnya:
@variable_name
. Untuk variabel berbasis label, tambahkan .value
ke
nama variabel, @my_label_based_variabe.value
.
Untuk kueri SQL, penggantian variabel mengandalkan BigQuery, dan aman dari injeksi SQL. Untuk mengetahui informasi selengkapnya, lihat Menjalankan kueri berparameter.
Konsol
Karena SQL tidak menafsirkan operator karakter pengganti sebagai "nilai apa pun", sebaiknya Anda selalu menggunakan pernyataan IF
saat menggunakan variabel dalam kueri SQL. Contoh berikut menggambarkan penggunaan untuk
variabel khusus nilai yang jenis datanya adalah string:
WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)
Jika opsi menu untuk variabel memungkinkan pengguna memilih beberapa nilai,
Anda harus melakukan transmisi
nilai variabel ke jenis data GoogleSQL menggunakan
fungsi CAST
.
Kueri berikut menggambarkan sintaksis ini:
IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE, severity IN UNNEST(@my_value_only_variable))
Pernyataan IF
yang ditampilkan dalam contoh sebelumnya direkomendasikan karena SQL
tidak menafsirkan operator wildcard berarti "nilai apa pun". Oleh karena itu, jika Anda
menghilangkan pernyataan IF
dan jika Anda memilih operator karakter pengganti,
maka hasil kueri adalah tabel kosong. Pada contoh kedua,
fungsi UNNEST
mengonversi
larik menjadi tabel.
Untuk menambahkan klausa WHERE
yang diformat dengan benar, lakukan langkah-langkah berikut:
- Edit widget.
- Di toolbar, pilih Sisipkan filter variabel, lalu pilih
variabel yang ingin Anda perbarui klausa
WHERE
-nya. - Dalam dialog yang terbuka, tinjau kode yang dihasilkan, lalu klik Salin dan tutup.
Tempel kode yang disalin ke panel Kueri dan lakukan pengeditan yang diperlukan.
Misalnya, Anda membuat variabel bernama
LogName
yang menghasilkan daftar nama log dan menampilkan hasilnya dalam tabel dengan satu kolom bernamalog_name
. Selanjutnya, Anda membuat diagram, memilih Sisipkan filter variabel, lalu memilih variabelLogName
. Kode berikut akan dibuat:WHERE IF(@LogName = '*', TRUE, LogName = @LogName)
Dalam contoh ini, Anda perlu mengedit kode yang dihasilkan dan mengganti
LogName =
denganlog_name =
, sehingga penggabungan tabel dapat terjadi:WHERE IF(@LogName = '*', TRUE, log_name = @LogName)
Klik Jalankan, lalu Terapkan.
Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
API
Karena SQL tidak menafsirkan operator karakter pengganti sebagai "nilai apa pun", sebaiknya Anda selalu menggunakan pernyataan IF
saat menggunakan variabel dalam kueri SQL. Contoh berikut menggambarkan penggunaan untuk
variabel khusus nilai yang jenis datanya adalah string:
WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)
Misalnya, berikut menunjukkan representasi JSON parsial dari diagram yang menampilkan hasil kueri SQL. Untuk mendukung pemfilteran hasil
menurut nama log, klausa WHERE
ditambahkan yang mereferensikan variabel
bernama LogName
:
"plotType": "STACKED_BAR", "targetAxis": "Y1", "timeSeriesQuery": { "opsAnalyticsQuery": { "queryExecutionRules": {}, "queryHandle": "", "sql": "SELECT\n timestamp, severity, resource.type, log_name, text_payload, proto_payload, json_payload\n FROM\n `my-project.global._Default._Default`\n WHERE \n IF (@LogName = \"*\", TRUE, log_name=@LogName)\nLIMIT 10000" } }
Variabel LogName
juga mengeluarkan kueri untuk menentukan daftar
kemungkinan nama log:
"dashboardFilters": [ { "filterType": "VALUE_ONLY", "templateVariable": "LogName", "valueType": "STRING", "timeSeriesQuery": { "opsAnalyticsQuery": { "savedQueryId": "", "sql": "SELECT log_name FROM `my-project.global._Default._Default` GROUP BY log_name LIMIT 1000", "queryHandle": "" }, "unitOverride": "", "outputFullDuration": false } } ],
Jika opsi menu untuk variabel memungkinkan pengguna memilih beberapa nilai,
Anda harus melakukan transmisi
nilai variabel ke jenis data GoogleSQL menggunakan
fungsi CAST
.
Kueri berikut menggambarkan sintaksis ini:
IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE, severity IN UNNEST(@my_value_only_variable))
Pernyataan IF
yang ditampilkan dalam contoh sebelumnya direkomendasikan karena SQL
tidak menafsirkan operator wildcard berarti "nilai apa pun". Oleh karena itu, jika Anda
menghilangkan pernyataan IF
dan jika Anda memilih operator karakter pengganti,
maka hasil kueri adalah tabel kosong. Pada contoh kedua,
fungsi UNNEST
mengonversi
larik menjadi tabel.
Diagram dengan kueri MQL
Untuk membuat diagram yang memiliki kueri MQL menggunakan variabel berbasis label, tambahkan tanda hubung, (|)
, lalu ikuti panduan yang tercantum di Sintaksis umum.
Saat Anda menggunakan antarmuka berbasis menu untuk membuat diagram yang menampilkan data deret waktu, pilihan Anda akan dikonversi menjadi filter Monitoring
Konsol
Misalnya, kueri berikut mengandalkan variabel berbasis label, my_label_based_variable
, yang diubah menjadi ekspresi filter:
fetch gce_instance | metric 'compute.googleapis.com/instance/cpu/utilization' | every 1m | ${my_label_based_variable}
Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel.
Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai
kueri berbasis label dengan instance_id
:
fetch gce_instance | metric 'compute.googleapis.com/instance/cpu/utilization' | filter resource.instance_id=~'${my_label_based_variable.value}' | group_by 1m, [value_utilization_mean: mean(value.utilization)] | every 1m
Jika Anda memiliki variabel khusus nilai, hapus klausa .value
. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:
resource.zone=~'${my_value_only_variable}'
API
Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable
, yang diubah menjadi ekspresi filter:
"timeSeriesQuery": { "timeSeriesQueryLanguage": "fetch gce_instance\n | metric 'compute.googleapis.com/instance/cpu/utilization'\n | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n | every 1m\n | ${my_label_based_variable}", "unitOverride": "", "outputFullDuration": false },
Anda juga dapat mengubah kueri untuk menyelesaikan hanya nilai variabel.
Contoh berikut menggunakan ekspresi reguler untuk membandingkan nilai
kueri berbasis label dengan instance_id
:
"timeSeriesQuery": { "timeSeriesQueryLanguage": "fetch gce_instance\n | metric 'compute.googleapis.com/instance/cpu/utilization'\n | filter resource.instance_id=~'${my_label_based_variable.value}'\n | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n | every 1m\n", "unitOverride": "", "outputFullDuration": false },
Jika Anda memiliki variabel khusus nilai, hapus klausa .value
. Misalnya, untuk memfilter menurut zona menggunakan variabel khusus nilai, kueri akan menyertakan sesuatu seperti berikut:
resource.zone=~'${my_value_only_variable}'
Tabel berikut menggambarkan cara variabel contoh diselesaikan oleh MQL. Seperti yang disebutkan sebelumnya, jika hanya nilai variabel yang digunakan, Anda harus menggunakan ekspresi reguler sebagai operator perbandingan:
Sintaks | Nilai Yang Dipilih |
Ekspresi MQL yang diselesaikan |
---|---|---|
${my_label_based_variable} |
12345 |
filter (resource.instance_id == '12345')
Variabel contoh didasarkan pada label resource
|
${my_label_based_variable} |
* |
filter (true) |
${my_label_based_variable.value} ${my_value_based_variable} |
12345 |
12345 |
${my_label_based_variable.value} ${my_value_based_variable} |
* |
.* |
Diagram dengan kueri filter Monitoring
Untuk memperbarui diagram yang memiliki kueri dalam bentuk filter Pemantauan agar bergantung pada variabel berbasis label, ikuti panduan yang tercantum di Sintaksis umum.
Konsol
Jika Anda menggunakan konsol Google Cloud untuk membuat diagram, dan jika Anda menggunakan antarmuka berbasis menu, Anda dapat memperbarui kueri diagram dengan menggunakan kolom Terapkan ke diagram variabel atau dengan mengedit widget dan memilih variabel berbasis label dari menu Filter. Menu Filter mencantumkan semua variabel berbasis label dan semua kunci label.
Untuk memperbarui kueri diagram agar bergantung pada variabel berbasis nilai, lakukan hal berikut:
- Edit diagram.
- Di panel kueri, klik Tambahkan filter, lalu pilih kunci label. Misalnya, Anda dapat memilih zona.
- Di menu Nilai, pilih variabel khusus nilai Anda.
- Klik Terapkan.
- Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable
, yang diubah menjadi ekspresi filter:
metric.type="compute.googleapis.com/instance/cpu/utilization" resource.type="gce_instance" ${my_label_based_variable}"
Widget yang menggunakan kueri dalam bentuk filter Monitoring tidak dapat memfilter deret waktu menurut nilai dalam variabel berbasis label; namun, Anda dapat memfilter menurut variabel hanya nilai.
Misalnya, kueri berikut menampilkan nilai kolom Filters
dari kueri yang memfilter menurut zone
, berdasarkan nilai variabel hanya nilai:
metric.type="compute.googleapis.com/instance/cpu/utilization" resource.type="gce_instance" resource.label."zone"=monitoring.regex.full_match(${my_value_only_variable})
API
Misalnya, JSON berikut menggambarkan kueri yang mengandalkan variabel berbasis label, my_label_based_variable
, yang diubah menjadi ekspresi filter:
"timeSeriesQuery": { "timeSeriesFilter": { "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" ${my_label_based_variable} ", "aggregation": { "alignmentPeriod": "60s", "perSeriesAligner": "ALIGN_MEAN", "groupByFields": [] } }, "unitOverride": "", "outputFullDuration": false },
Widget yang menggunakan kueri dalam bentuk filter Monitoring tidak dapat memfilter deret waktu menurut nilai dalam variabel berbasis label; namun, Anda dapat memfilter menurut variabel hanya nilai.
Misalnya, kueri berikut menampilkan kolom "filter"
dari kueri yang
memfilter menurut zone
, berdasarkan nilai variabel hanya nilai:
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" resource.labels.\"zone\"=monitoring.regex.full_match(${my_value_only_variable})"
Tabel berikut menggambarkan cara variabel contoh diselesaikan oleh filter Pemantauan. Seperti yang disebutkan sebelumnya, jika hanya nilai variabel yang digunakan, Anda harus menggunakan ekspresi reguler sebagai operator perbandingan:
Sintaks | Nilai Yang Dipilih |
Ekspresi filter yang diselesaikan |
---|---|---|
${my_label_based_variable} |
12345 |
resource.instance_id == "12345"
Variabel contoh didasarkan pada label resource
|
${my_label_based_variable} |
* |
Dihilangkan |
${my_label_based_variable.value} |
12345 |
Tidak didukung |
${my_label_based_variable.value} |
* |
Tidak didukung |
${my_value_based_variable} |
12345 |
"12345" |
${my_value_based_variable} |
* |
".*" |
Mengubah filter atau variabel yang disematkan
Untuk mengubah nilai filter apa pun yang ditampilkan di toolbar dasbor untuk sementara, klik nama filter, lalu masukkan nilai atau pilih dari menu.
Jika dasbor Anda berisi tabel yang menampilkan data deret waktu, Anda dapat menambahkan filter sementara atau mengubah filter dan variabel permanen dengan menggunakan tombol filter_list Filter dasbor ke nilai ini di sel. Tombol ini, jika dipilih, akan menerapkan filter sementara baru atau memperbarui nilai untuk filter atau variabel yang ada. Filter dan variabel yang ada diperbarui saat kunci label untuk kolom tabel cocok dengan kunci label untuk filter atau variabel.
Untuk mengubah konfigurasi filter yang disematkan atau variabel, lakukan hal berikut:
-
Di konsol Google Cloud , buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
- Di toolbar dasbor, klik settings Setelan.
- Temukan filter atau variabel yang ingin Anda ubah dan luaskan definisinya.
- Setelah Anda menyelesaikan modifikasi, klik Terapkan.
- Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.
Menghapus filter atau variabel yang disematkan
Untuk menghapus filter atau variabel yang disematkan, lakukan langkah-langkah berikut:
-
Di konsol Google Cloud , buka halaman
Dasbor:
Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.
- Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder yang mendukung aplikasi.
- Di toolbar dasbor, klik settings Setelan.
- Temukan filter atau variabel yang ingin Anda hapus, lalu klik Hapus.
- Klik Terapkan.
- Untuk menyimpan dasbor yang telah diubah, di toolbar, klik Simpan.