Alat: get_alert_policy
Gunakan ini sebagai alat utama untuk mendapatkan informasi tentang kebijakan pemberitahuan tertentu. Kebijakan pemberitahuan menentukan kondisi saat Anda ingin mendapatkan pemberitahuan tentang masalah pada layanan Anda. Hal ini berguna untuk memahami detail konfigurasi notifikasi tertentu.
Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_alert_policy.
| Permintaan Curl |
|---|
curl --location 'https://monitoring.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_alert_policy", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Skema Input
Protokol untuk permintaan GetAlertPolicy.
GetAlertPolicyRequest
| Representasi JSON |
|---|
{ "name": string } |
| Kolom | |
|---|---|
name |
Wajib. Kebijakan pemberitahuan yang akan diambil. Formatnya adalah: |
Skema Output
Deskripsi kondisi yang menyebabkan beberapa aspek sistem Anda dianggap "tidak responsif" dan cara untuk memberi tahu orang atau layanan tentang kondisi ini. Untuk ringkasan kebijakan pemberitahuan, lihat Pengantar Pemberitahuan.
AlertPolicy
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "documentation": { object ( |
| Kolom | |
|---|---|
name |
ID. Wajib jika kebijakan ada. Nama resource untuk kebijakan ini. Formatnya adalah:
|
displayName |
Nama atau frasa singkat yang digunakan untuk mengidentifikasi kebijakan di dasbor, notifikasi, dan insiden. Agar tidak membingungkan, jangan gunakan nama tampilan yang sama untuk beberapa kebijakan dalam project yang sama. Nama dibatasi hingga 512 karakter Unicode. Konvensi untuk display_name PrometheusQueryLanguageCondition adalah "{rule group name}/{alert name}", dengan {rule group name} dan {alert name} harus diambil dari file konfigurasi Prometheus yang sesuai. Konvensi ini tidak diterapkan. Bagaimanapun, display_name bukanlah kunci unik AlertPolicy. |
documentation |
Dokumentasi yang disertakan dengan notifikasi dan insiden terkait kebijakan ini. Praktik terbaiknya adalah dokumentasi harus menyertakan informasi untuk membantu responden memahami, mengurangi, meningkatkan, dan memperbaiki masalah mendasar yang terdeteksi oleh kebijakan pemberitahuan. Channel notifikasi yang memiliki kapasitas terbatas mungkin tidak menampilkan dokumentasi ini. |
userLabels |
Data key/value yang disediakan pengguna untuk digunakan dalam mengatur dan mengidentifikasi objek Kolom dapat berisi hingga 64 entri. Setiap kunci dan nilai dibatasi hingga 63 karakter Unicode atau 128 byte, mana saja yang lebih kecil. Label dan nilai hanya boleh berisi huruf kecil, angka, garis bawah, dan tanda hubung. Kunci harus diawali dengan huruf. Perhatikan bahwa Prometheus {alert name} adalah nama label Prometheus yang valid, sedangkan Prometheus {rule group} adalah string UTF-8 yang tidak dibatasi. Artinya, nilai tersebut tidak dapat disimpan apa adanya di label pengguna, karena mungkin berisi karakter yang tidak diizinkan dalam nilai label pengguna. Objek yang berisi daftar pasangan |
conditions[] |
Daftar kondisi untuk kebijakan. Kondisi digabungkan dengan AND atau OR sesuai dengan kolom |
combiner |
Cara menggabungkan hasil beberapa kondisi untuk menentukan apakah insiden harus dibuka. Jika |
enabled |
Apakah kebijakan diaktifkan atau tidak. Saat penulisan, interpretasi default jika tidak disetel adalah bahwa kebijakan diaktifkan. Saat membaca, klien tidak boleh membuat asumsi apa pun tentang status jika belum diisi. Kolom harus selalu diisi pada operasi List dan Get, kecuali jika proyeksi kolom telah ditentukan yang menghapusnya. |
validity |
Deskripsi hanya baca tentang alasan kebijakan pemberitahuan tidak valid. Kolom ini hanya disetel jika kebijakan pemberitahuan tidak valid. Kebijakan pemberitahuan yang tidak valid tidak akan menghasilkan insiden. |
notificationChannels[] |
Mengidentifikasi saluran notifikasi yang akan dikirimi notifikasi saat insiden dibuka atau ditutup atau saat terjadi pelanggaran baru pada insiden yang sudah dibuka. Setiap elemen array ini sesuai dengan kolom |
creationRecord |
Catatan hanya baca tentang pembuatan kebijakan pemberitahuan. Jika diberikan dalam panggilan untuk membuat atau memperbarui, kolom ini akan diabaikan. |
mutationRecord |
Catatan hanya baca tentang perubahan terbaru pada kebijakan pemberitahuan. Jika diberikan dalam panggilan untuk membuat atau memperbarui, kolom ini akan diabaikan. |
alertStrategy |
Kontrol atas cara saluran notifikasi kebijakan pemberitahuan ini diberi tahu. |
severity |
Opsional. Tingkat keparahan kebijakan pemberitahuan menunjukkan seberapa penting insiden yang dihasilkan oleh kebijakan tersebut. Tingkat keparahan akan ditampilkan di halaman detail Insiden dan dalam notifikasi. |
Dokumentasi
| Representasi JSON |
|---|
{
"content": string,
"mimeType": string,
"subject": string,
"links": [
{
object ( |
| Kolom | |
|---|---|
content |
Isi dokumentasi, ditafsirkan sesuai dengan |
mimeType |
Format kolom |
subject |
Opsional. Baris subjek notifikasi. Baris subjek tidak boleh melebihi 10.240 byte. Dalam notifikasi yang dibuat oleh kebijakan ini, konten baris subjek setelah perluasan variabel akan dipangkas hingga 255 byte atau lebih pendek pada batas karakter UTF-8 terbaru. Batas 255 byte direkomendasikan oleh rangkaian pesan ini. Batas ini diberlakukan oleh beberapa produk tiket pihak ketiga dan umumnya kolom tekstual dalam database ditentukan sebagai VARCHAR(255). Isi baris subjek dapat dibuat menggunakan template dengan variabel. Jika kolom ini tidak ada atau kosong, baris subjek default akan dibuat. |
links[] |
Opsional. Link ke konten seperti playbook, repositori, dan resource lainnya. Kolom ini dapat berisi hingga 3 entri. |
Link
| Representasi JSON |
|---|
{ "displayName": string, "url": string } |
| Kolom | |
|---|---|
displayName |
Nama tampilan singkat untuk link. Nama tampilan tidak boleh kosong atau melebihi 63 karakter. Contoh: "playbook". |
url |
URL halaman web. URL dapat dibuat menjadi template dengan menggunakan variabel di jalur atau parameter kueri. Panjang total URL tidak boleh melebihi 2083 karakter sebelum dan setelah perluasan variabel. Contoh: "https://my_domain.com/playbook?name=${resource.name}" |
UserLabelsEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
Kondisi
| Representasi JSON |
|---|
{ "name": string, "displayName": string, // Union field |
| Kolom | |
|---|---|
name |
Wajib jika kondisi ada. Nama resource unik untuk kondisi ini. Formatnya adalah:
Saat memanggil metode Saat memanggil metode Praktik terbaiknya adalah mempertahankan |
displayName |
Nama atau frasa singkat yang digunakan untuk mengidentifikasi kondisi dalam dasbor, notifikasi, dan insiden. Untuk menghindari kebingungan, jangan gunakan nama tampilan yang sama untuk beberapa kondisi dalam kebijakan yang sama. |
Kolom union condition. Hanya satu jenis kondisi berikut yang akan ditentukan. condition hanya ada berupa salah satu diantara berikut: |
|
conditionThreshold |
Kondisi yang membandingkan deret waktu dengan nilai minimum. |
conditionAbsent |
Kondisi yang memeriksa apakah deret waktu terus menerima titik data baru. |
conditionMatchedLog |
Kondisi yang memeriksa pesan log yang cocok dengan batasan tertentu. Jika disetel, tidak ada kondisi lain yang dapat muncul. |
conditionMonitoringQueryLanguage |
Kondisi yang menggunakan Monitoring Query Language untuk menentukan pemberitahuan. |
conditionPrometheusQueryLanguage |
Kondisi yang menggunakan bahasa kueri Prometheus untuk menentukan pemberitahuan. |
conditionSql |
Kondisi yang secara berkala mengevaluasi hasil kueri SQL. |
MetricThreshold
| Representasi JSON |
|---|
{ "filter": string, "aggregations": [ { object ( |
| Kolom | |
|---|---|
filter |
Wajib. Filter yang mengidentifikasi deret waktu mana yang harus dibandingkan dengan nilai minimum. Filter ini mirip dengan filter yang ditentukan dalam permintaan |
aggregations[] |
Menentukan perataan titik data dalam deret waktu individual serta cara menggabungkan deret waktu yang diambil (seperti saat menggabungkan beberapa aliran pada setiap resource menjadi satu aliran untuk setiap resource atau saat menggabungkan aliran di semua anggota grup resource). Beberapa agregasi diterapkan sesuai urutan yang ditentukan. Kolom ini mirip dengan kolom dalam permintaan |
denominatorFilter |
Filter yang mengidentifikasi deret waktu yang harus digunakan sebagai penyebut rasio yang akan dibandingkan dengan nilai minimum. Jika Filter harus menentukan jenis metrik dan secara opsional dapat berisi batasan pada jenis resource, label resource, dan label metrik. Kolom ini tidak boleh melebihi 2.048 karakter Unicode. |
denominatorAggregations[] |
Menentukan perataan titik data dalam deret waktu individual yang dipilih oleh Saat menghitung rasio, kolom |
forecastOptions |
Jika kolom ini ada, kondisi |
comparison |
Perbandingan yang akan diterapkan antara deret waktu (ditunjukkan oleh Saat ini, hanya |
thresholdValue |
Nilai yang akan dibandingkan dengan deret waktu. |
duration |
Wajib. Durasi waktu deret waktu harus melanggar nilai minimum agar dianggap gagal. Saat ini, hanya nilai yang merupakan kelipatan menit--misalnya, 0, 60, 120, atau 300 detik--yang didukung. Jika nilai yang tidak valid diberikan, error akan ditampilkan. Saat memilih durasi, sebaiknya perhatikan frekuensi data deret waktu pokok (yang juga dapat dipengaruhi oleh perataan yang ditentukan di kolom Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
trigger |
Jumlah/persen deret waktu yang perbandingannya harus berlaku agar kondisi dipicu. Jika tidak ditentukan, kondisi akan dipicu jika perbandingan benar untuk deret waktu yang telah diidentifikasi oleh |
evaluationMissingData |
Kontrol kondisi yang menentukan cara kondisi batas metrik dievaluasi saat data berhenti tiba. Untuk menggunakan kontrol ini, nilai kolom |
Agregasi
| Representasi JSON |
|---|
{ "alignmentPeriod": string, "perSeriesAligner": enum ( |
| Kolom | |
|---|---|
alignmentPeriod |
Nilainya harus minimal 60 detik. Jika alat perata per seri selain Nilai maksimum Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
perSeriesAligner |
Tidak semua operasi penyelarasan dapat diterapkan ke semua deret waktu. Pilihan yang valid bergantung pada Data deret waktu harus disejajarkan untuk melakukan pengurangan deret waktu lintas. Jika |
crossSeriesReducer |
Operasi pengurangan yang akan digunakan untuk menggabungkan deret waktu menjadi satu deret waktu, dengan nilai setiap titik data dalam deret yang dihasilkan adalah fungsi dari semua nilai yang sudah diselaraskan dalam deret waktu input. Tidak semua operasi peredam dapat diterapkan ke semua deret waktu. Pilihan yang valid bergantung pada Data deret waktu harus diselaraskan terlebih dahulu (lihat |
groupByFields[] |
Kumpulan kolom yang akan dipertahankan saat |
Durasi
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Detik bertanda dari rentang waktu. Harus dari -315.576.000.000 hingga +315.576.000.000 inklusif. Catatan: batas ini dihitung dari: 60 dtk/mnt * 60 mnt/jam * 24 jam/hari * 365,25 hari/tahun * 10.000 tahun |
nanos |
Pecahan detik bertanda pada resolusi nanodetik rentang waktu. Durasi kurang dari satu detik ditampilkan dengan kolom |
ForecastOptions
| Representasi JSON |
|---|
{ "forecastHorizon": string } |
| Kolom | |
|---|---|
forecastHorizon |
Wajib. Durasi waktu ke masa depan untuk memperkirakan apakah deret waktu akan melanggar nilai minimum. Jika nilai yang diprediksi terbukti melanggar nilai minimum, dan pelanggaran tersebut diamati di semua perkiraan yang dibuat untuk Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
Pemicu
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union type. Jenis pemicu. type hanya ada berupa salah satu diantara berikut: |
|
count |
Jumlah absolut deret waktu yang harus gagal dalam predikat agar kondisi dipicu. |
percent |
Persentase deret waktu yang harus gagal dalam predikat agar kondisi dipicu. |
MetricAbsence
| Representasi JSON |
|---|
{ "filter": string, "aggregations": [ { object ( |
| Kolom | |
|---|---|
filter |
Wajib. Filter yang mengidentifikasi deret waktu mana yang harus dibandingkan dengan nilai minimum. Filter ini mirip dengan filter yang ditentukan dalam permintaan |
aggregations[] |
Menentukan perataan titik data dalam deret waktu individual serta cara menggabungkan deret waktu yang diambil (seperti saat menggabungkan beberapa aliran pada setiap resource menjadi satu aliran untuk setiap resource atau saat menggabungkan aliran di semua anggota grup resource). Beberapa agregasi diterapkan sesuai urutan yang ditentukan. Kolom ini mirip dengan kolom dalam permintaan |
duration |
Wajib. Jumlah waktu yang diperlukan agar deret waktu dianggap gagal melaporkan data baru. Nilai minimum kolom ini adalah 120 detik. Nilai yang lebih besar yang merupakan kelipatan satu menit, misalnya, 240 atau 300 detik, didukung. Jika nilai yang tidak valid diberikan, error akan ditampilkan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
trigger |
Jumlah/persen deret waktu yang perbandingannya harus berlaku agar kondisi dipicu. Jika tidak ditentukan, kondisi akan dipicu jika perbandingan benar untuk deret waktu yang telah diidentifikasi oleh |
LogMatch
| Representasi JSON |
|---|
{ "filter": string, "labelExtractors": { string: string, ... } } |
| Kolom | |
|---|---|
filter |
Wajib. Filter berbasis log. Lihat Kueri Log Lanjutan untuk mengetahui cara membuat filter ini. |
labelExtractors |
Opsional. Pemetaan dari kunci label ke ekspresi ekstraktor, yang digunakan untuk mengekstrak nilai untuk kunci label ini. Setiap entri dalam peta ini adalah spesifikasi tentang cara data harus diekstrak dari entri log yang cocok dengan Lihat dokumentasi tentang metrik berbasis log Objek yang berisi daftar pasangan |
LabelExtractorsEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
MonitoringQueryLanguageCondition
| Representasi JSON |
|---|
{ "query": string, "duration": string, "trigger": { object ( |
| Kolom | |
|---|---|
query |
Kueri Monitoring Query Language yang menghasilkan aliran boolean. |
duration |
Opsional. Durasi waktu deret waktu harus melanggar nilai minimum agar dianggap gagal. Saat ini, hanya nilai yang merupakan kelipatan menit--misalnya, 0, 60, 120, atau 300 detik--yang didukung. Jika nilai yang tidak valid diberikan, error akan ditampilkan. Saat memilih durasi, sebaiknya perhatikan frekuensi data deret waktu pokok (yang juga dapat dipengaruhi oleh perataan yang ditentukan di kolom Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
trigger |
Jumlah/persen deret waktu yang perbandingannya harus berlaku agar kondisi dipicu. Jika tidak ditentukan, kondisi akan dipicu jika perbandingan benar untuk deret waktu yang telah diidentifikasi oleh |
evaluationMissingData |
Kontrol kondisi yang menentukan cara kondisi batas metrik dievaluasi saat data berhenti tiba. |
PrometheusQueryLanguageCondition
| Representasi JSON |
|---|
{ "query": string, "duration": string, "evaluationInterval": string, "labels": { string: string, ... }, "ruleGroup": string, "alertRule": string, "disableMetricValidation": boolean } |
| Kolom | |
|---|---|
query |
Wajib. Ekspresi PromQL yang akan dievaluasi. Setiap siklus evaluasi, ekspresi ini dievaluasi pada waktu saat ini, dan semua deret waktu yang dihasilkan akan menjadi pemberitahuan tertunda/aktif. Kolom ini tidak boleh kosong. |
duration |
Opsional. Pemberitahuan dianggap diaktifkan setelah ekspresi PromQL-nya dievaluasi sebagai "benar" selama ini. Pemberitahuan yang ekspresi PromQL-nya tidak dievaluasi sebagai "true" dalam waktu yang cukup lama dianggap tertunda. Harus berupa durasi non-negatif atau tidak ada. Kolom ini bersifat opsional. Nilai defaultnya adalah nol. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
evaluationInterval |
Opsional. Seberapa sering aturan ini harus dievaluasi. Harus berupa kelipatan 30 detik yang positif atau tidak ada. Kolom ini bersifat opsional. Nilai defaultnya adalah 30 detik. Jika PrometheusQueryLanguageCondition ini dibuat dari aturan pemberitahuan Prometheus, nilai ini harus diambil dari grup aturan yang melampirkan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
labels |
Opsional. Label yang akan ditambahkan atau diganti dalam hasil kueri PromQL. Nama label harus valid. Nilai label dapat dibuat menggunakan template dengan variabel. Satu-satunya nama variabel yang tersedia adalah nama label dalam hasil PromQL, termasuk "__name__" dan "value". "labels" mungkin kosong. Objek yang berisi daftar pasangan |
ruleGroup |
Opsional. Nama grup aturan pemberitahuan ini dalam file konfigurasi Prometheus yang sesuai. Beberapa alat eksternal mungkin memerlukan pengisian kolom ini dengan benar untuk merujuk ke file konfigurasi Prometheus asli. Nama grup aturan dan nama pemberitahuan diperlukan untuk memperbarui AlertPolicies yang relevan jika definisi grup aturan berubah di masa mendatang. Kolom ini bersifat opsional. Jika kolom ini tidak kosong, maka harus berisi string UTF-8 yang valid. Kolom ini tidak boleh melebihi 2.048 karakter Unicode. |
alertRule |
Opsional. Nama aturan pemberitahuan untuk pemberitahuan ini dalam file konfigurasi Prometheus yang sesuai. Beberapa alat eksternal mungkin memerlukan pengisian kolom ini dengan benar untuk merujuk ke file konfigurasi Prometheus asli. Nama grup aturan dan nama pemberitahuan diperlukan untuk memperbarui AlertPolicies yang relevan jika definisi grup aturan berubah di masa mendatang. Kolom ini bersifat opsional. Jika kolom ini tidak kosong, maka harus berupa nama label Prometheus yang valid. Kolom ini tidak boleh melebihi 2.048 karakter Unicode. |
disableMetricValidation |
Opsional. Apakah akan menonaktifkan validasi keberadaan metrik untuk kondisi ini. Hal ini memungkinkan kebijakan pemberitahuan ditentukan pada metrik yang belum ada, sehingga meningkatkan alur kerja pelanggan tingkat lanjut seperti mengonfigurasi kebijakan pemberitahuan menggunakan Terraform. Pengguna dengan peran |
LabelsEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
SqlCondition
| Representasi JSON |
|---|
{ "query": string, // Union field |
| Kolom | |
|---|---|
query |
Wajib. Kueri SQL Log Analytics yang akan dijalankan, sebagai string. Kueri harus sesuai dengan bentuk yang diperlukan. Secara khusus, kueri tidak boleh mencoba memfilter input menurut waktu. Filter akan otomatis diterapkan untuk memfilter input sehingga kueri menerima semua baris yang diterima sejak terakhir kali kueri dijalankan. Misalnya, kueri berikut mengekstrak semua entri log yang berisi permintaan HTTP: |
Kolom union schedule. Jadwal menunjukkan seberapa sering kueri harus dijalankan. schedule hanya ada berupa salah satu diantara berikut: |
|
minutes |
Jadwalkan kueri untuk dijalankan setiap beberapa menit. |
hourly |
Jadwalkan kueri untuk dieksekusi setiap beberapa jam. |
daily |
Jadwalkan kueri untuk dijalankan setiap beberapa hari. |
Kolom union evaluate. Pengujian yang akan dijalankan terhadap kumpulan hasil SQL. evaluate hanya ada berupa salah satu diantara berikut: |
|
rowCountTest |
Uji jumlah baris terhadap nilai minimum. |
booleanTest |
Uji nilai boolean di kolom yang ditunjukkan. |
Menit
| Representasi JSON |
|---|
{ "periodicity": integer } |
| Kolom | |
|---|---|
periodicity |
Wajib. Jumlah menit antar-proses. Interval harus lebih besar dari atau sama dengan 5 menit dan kurang dari atau sama dengan 1.440 menit. |
Per jam
| Representasi JSON |
|---|
{ "periodicity": integer, // Union field |
| Kolom | |
|---|---|
periodicity |
Wajib. Jumlah jam di antara proses. Harus lebih besar dari atau sama dengan 1 jam dan kurang dari atau sama dengan 48 jam. |
Kolom union
|
|
minuteOffset |
Opsional. Jumlah menit setelah satu jam (dalam UTC) untuk menjalankan kueri. Harus lebih besar dari atau sama dengan 0 menit dan kurang dari atau sama dengan 59 menit. Jika tidak ditentukan, offset arbitrer akan digunakan. |
Harian
| Representasi JSON |
|---|
{
"periodicity": integer,
"executionTime": {
object ( |
| Kolom | |
|---|---|
periodicity |
Wajib. Jumlah hari antara proses. Harus lebih besar dari atau sama dengan 1 hari dan kurang dari atau sama dengan 31 hari. |
executionTime |
Opsional. Waktu dalam sehari (dalam UTC) saat kueri harus dijalankan. Jika tidak ditentukan, server akan memilih waktu yang acak dalam sehari dan menjalankan kueri pada waktu yang sama setiap hari. |
TimeOfDay
| Representasi JSON |
|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
| Kolom | |
|---|---|
hours |
Jam dalam format 24 jam. Harus lebih besar dari atau sama dengan 0 dan biasanya harus kurang dari atau sama dengan 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti waktu tutup bisnis. |
minutes |
Menit dalam satu jam. Harus lebih besar dari atau sama dengan 0 dan kurang dari atau sama dengan 59. |
seconds |
Detik dalam satu menit. Harus lebih besar dari atau sama dengan 0 dan biasanya harus kurang dari atau sama dengan 59. API dapat mengizinkan nilai 60 jika memungkinkan lompatan-detik. |
nanos |
Pecahan detik, dalam nanodetik. Harus lebih besar dari atau sama dengan 0 dan kurang dari atau sama dengan 999.999.999. |
RowCountTest
| Representasi JSON |
|---|
{
"comparison": enum ( |
| Kolom | |
|---|---|
comparison |
Wajib. Perbandingan yang akan diterapkan antara jumlah baris yang ditampilkan oleh kueri dan nilai minimum. |
threshold |
Wajib. Nilai yang akan dibandingkan dengan jumlah baris. |
BooleanTest
| Representasi JSON |
|---|
{ "column": string } |
| Kolom | |
|---|---|
column |
Wajib. Nama kolom yang berisi nilai boolean. Jika nilai dalam baris adalah NULL, baris tersebut akan diabaikan. |
BoolValue
| Representasi JSON |
|---|
{ "value": boolean } |
| Kolom | |
|---|---|
value |
Nilai bool. |
Status
| Representasi JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Kolom | |
|---|---|
code |
Kode status, harus berupa nilai enum dari |
message |
Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom |
details[] |
Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
Semua
| Representasi JSON |
|---|
{ "typeUrl": string, "value": string } |
| Kolom | |
|---|---|
typeUrl |
Mengidentifikasi jenis pesan Protobuf berserial dengan referensi URI yang terdiri dari awalan yang diakhiri dengan garis miring dan nama jenis yang sepenuhnya memenuhi syarat. Contoh: type.googleapis.com/google.protobuf.StringValue String ini harus berisi setidaknya satu karakter Awalan bersifat arbitrer dan implementasi Protobuf diharapkan cukup menghapus semua yang ada hingga dan termasuk Semua string URL jenis harus berupa referensi URI yang valid dengan batasan tambahan (untuk format teks) bahwa konten referensi hanya boleh terdiri dari karakter alfanumerik, escape yang dienkode persen, dan karakter dalam set berikut (tidak termasuk tanda petik terbalik luar): Dalam desain asli |
value |
Berisi serialisasi Protobuf dari jenis yang dijelaskan oleh type_url. String berenkode base64. |
MutationRecord
| Representasi JSON |
|---|
{ "mutateTime": string, "mutatedBy": string } |
| Kolom | |
|---|---|
mutateTime |
Waktu saat perubahan terjadi. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
mutatedBy |
Alamat email pengguna yang melakukan perubahan. |
Stempel waktu
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
AlertStrategy
| Representasi JSON |
|---|
{ "notificationRateLimit": { object ( |
| Kolom | |
|---|---|
notificationRateLimit |
Diperlukan untuk kebijakan pemberitahuan berbasis log, yaitu kebijakan dengan kondisi Batas ini tidak diterapkan untuk kebijakan pemberitahuan yang tidak memiliki kondisi LogMatch. |
notificationPrompts[] |
Untuk kebijakan pemberitahuan berbasis log, perintah notifikasi selalu [DIBUKA]. Untuk kebijakan pemberitahuan non-berbasis log, perintah notifikasi dapat berupa [DIBUKA] atau [DIBUKA, DITUTUP]. |
autoClose |
Jika kebijakan pemberitahuan yang aktif tidak memiliki data selama ini, semua insiden yang terbuka akan ditutup Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
notificationChannelStrategy[] |
Mengontrol cara notifikasi akan dikirim, berdasarkan per channel. |
NotificationRateLimit
| Representasi JSON |
|---|
{ "period": string } |
| Kolom | |
|---|---|
period |
Tidak lebih dari satu notifikasi per Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
NotificationChannelStrategy
| Representasi JSON |
|---|
{ "notificationChannelNames": [ string ], "renotifyInterval": string } |
| Kolom | |
|---|---|
notificationChannelNames[] |
Nama resource REST lengkap untuk saluran notifikasi yang menerapkan setelan ini. Setiap nilai ini sesuai dengan kolom nama di salah satu objek NotificationChannel yang dirujuk di kolom notification_channels dari AlertPolicy ini. Formatnya adalah: |
renotifyInterval |
Frekuensi pengiriman notifikasi pengingat untuk insiden yang belum diselesaikan. Nilainya harus antara 30 menit dan 24 jam. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
Perata
Aligner menentukan operasi yang akan diterapkan ke titik data dalam setiap periode perataan dalam deret waktu. Kecuali ALIGN_NONE, yang menentukan bahwa tidak ada operasi yang diterapkan, setiap operasi penyelarasan menggantikan kumpulan nilai data di setiap periode penyelarasan dengan satu nilai: hasil penerapan operasi ke nilai data. Deret waktu yang diselaraskan memiliki satu nilai data di akhir setiap alignment_period.
Operasi penyelarasan juga dapat mengubah jenis data nilai. Misalnya, jika Anda menerapkan operasi penghitungan ke nilai boolean, data value_type dalam deret waktu asli adalah BOOLEAN, tetapi value_type dalam hasil yang diselaraskan adalah INT64.
| Enum | |
|---|---|
ALIGN_NONE |
Tidak ada keselarasan. Data mentah ditampilkan. Tidak valid jika pengurangan lintas seri diminta. value_type hasil sama dengan value_type input. |
ALIGN_DELTA |
Sejajarkan dan konversikan ke Penyejajaran ini valid untuk metrik |
ALIGN_RATE |
Sejajarkan dan konversi ke nilai. Hasilnya dihitung sebagai Penyelarasan ini berlaku untuk metrik Jika yang Anda maksud dengan "rasio" adalah "perubahan persentase", lihat penyelarasan |
ALIGN_INTERPOLATE |
Menyelaraskan dengan melakukan interpolasi antara titik-titik yang berdekatan di sekitar batas periode penyelarasan. Penyelarasan ini valid untuk GAUGE metrik dengan nilai numerik. value_type hasil yang diselaraskan sama dengan value_type input. |
ALIGN_NEXT_OLDER |
Selaraskan dengan memindahkan titik data terbaru sebelum akhir periode penyelarasan ke batas di akhir periode penyelarasan. Penyelarasan ini valid untuk GAUGE metrik. value_type hasil yang diselaraskan sama dengan value_type input. |
ALIGN_MIN |
Menyelaraskan deret waktu dengan menampilkan nilai minimum di setiap periode penyelarasan. Penyelarasan ini berlaku untuk metrik GAUGE dan DELTA dengan nilai numerik. value_type hasil yang diselaraskan sama dengan value_type input. |
ALIGN_MAX |
Menyelaraskan deret waktu dengan menampilkan nilai maksimum di setiap periode penyelarasan. Penyelarasan ini berlaku untuk metrik GAUGE dan DELTA dengan nilai numerik. value_type hasil yang diselaraskan sama dengan value_type input. |
ALIGN_MEAN |
Selaraskan deret waktu dengan menampilkan nilai rata-rata di setiap periode penyelarasan. Penyelarasan ini berlaku untuk metrik GAUGE dan DELTA dengan nilai numerik. value_type dari hasil yang diselaraskan adalah DOUBLE. |
ALIGN_COUNT |
Selaraskan deret waktu dengan menampilkan jumlah nilai di setiap periode penyelarasan. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai numerik atau Boolean. value_type dari hasil yang diselaraskan adalah INT64. |
ALIGN_SUM |
Selaraskan deret waktu dengan menampilkan jumlah nilai di setiap periode penyelarasan. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai numerik dan distribusi. value_type hasil yang diselaraskan sama dengan value_type input. |
ALIGN_STDDEV |
Selaraskan deret waktu dengan menampilkan simpangan baku nilai di setiap periode penyelarasan. Penyelarasan ini berlaku untuk metrik GAUGE dan DELTA dengan nilai numerik. value_type outputnya adalah DOUBLE. |
ALIGN_COUNT_TRUE |
Selaraskan deret waktu dengan menampilkan jumlah nilai True di setiap periode penyelarasan. Penyelarasan ini valid untuk GAUGE metrik dengan nilai Boolean. value_type outputnya adalah INT64. |
ALIGN_COUNT_FALSE |
Selaraskan deret waktu dengan menampilkan jumlah nilai False di setiap periode penyelarasan. Penyelarasan ini valid untuk GAUGE metrik dengan nilai Boolean. value_type outputnya adalah INT64. |
ALIGN_FRACTION_TRUE |
Selaraskan deret waktu dengan menampilkan rasio jumlah nilai True terhadap jumlah total nilai di setiap periode penyelarasan. Penyelarasan ini valid untuk GAUGE metrik dengan nilai Boolean. Nilai output berada dalam rentang [0,0, 1,0] dan memiliki value_type DOUBLE. |
ALIGN_PERCENTILE_99 |
Sejajarkan deret waktu menggunakan agregasi persentil. Titik data yang dihasilkan dalam setiap periode perataan adalah persentil ke-99 dari semua titik data dalam periode tersebut. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai distribusi. Outputnya adalah metrik GAUGE dengan value_type DOUBLE. |
ALIGN_PERCENTILE_95 |
Sejajarkan deret waktu menggunakan agregasi persentil. Titik data yang dihasilkan dalam setiap periode perataan adalah persentil ke-95 dari semua titik data dalam periode tersebut. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai distribusi. Outputnya adalah metrik GAUGE dengan value_type DOUBLE. |
ALIGN_PERCENTILE_50 |
Sejajarkan deret waktu menggunakan agregasi persentil. Titik data yang dihasilkan dalam setiap periode perataan adalah persentil ke-50 dari semua titik data dalam periode tersebut. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai distribusi. Outputnya adalah metrik GAUGE dengan value_type DOUBLE. |
ALIGN_PERCENTILE_05 |
Sejajarkan deret waktu menggunakan agregasi persentil. Titik data yang dihasilkan dalam setiap periode perataan adalah persentil ke-5 dari semua titik data dalam periode tersebut. Penyelarasan ini valid untuk metrik GAUGE dan DELTA dengan nilai distribusi. Outputnya adalah metrik GAUGE dengan value_type DOUBLE. |
ALIGN_PERCENT_CHANGE |
Sejajarkan dan konversikan ke perubahan persentase. Penyelarasan ini berlaku untuk metrik Jika nilai Rata-rata bergerak 10 menit dihitung pada setiap titik periode penyelarasan sebelum penghitungan di atas untuk memperlancar metrik dan mencegah positif palsu dari lonjakan yang sangat singkat. Rata-rata bergerak hanya berlaku untuk data yang nilainya |
Pengurang
Operasi Reducer menjelaskan cara menggabungkan titik data dari beberapa deret waktu menjadi satu deret waktu, dengan nilai setiap titik data dalam deret yang dihasilkan adalah fungsi dari semua nilai yang sudah diselaraskan dalam deret waktu input.
| Enum | |
|---|---|
REDUCE_NONE |
Tidak ada pengurangan deret waktu lintas. Output Aligner ditampilkan. |
REDUCE_MEAN |
Mengurangi dengan menghitung nilai rata-rata di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dengan nilai numerik atau distribusi. value_type outputnya adalah DOUBLE. |
REDUCE_MIN |
Mengurangi dengan menghitung nilai minimum di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini berlaku untuk metrik DELTA dan GAUGE dengan nilai numerik. value_type output sama dengan value_type input. |
REDUCE_MAX |
Mengurangi dengan menghitung nilai maksimum di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini berlaku untuk metrik DELTA dan GAUGE dengan nilai numerik. value_type output sama dengan value_type input. |
REDUCE_SUM |
Mengurangi dengan menghitung jumlah di seluruh deret waktu untuk setiap periode perataan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dengan nilai numerik dan distribusi. value_type output sama dengan value_type input. |
REDUCE_STDDEV |
Mengurangi dengan menghitung simpangan baku di seluruh deret waktu untuk setiap periode perataan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dengan nilai numerik atau distribusi. value_type outputnya adalah DOUBLE. |
REDUCE_COUNT |
Mengurangi dengan menghitung jumlah titik data di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dari value_type numerik, Boolean, distribusi, dan string. value_type outputnya adalah INT64. |
REDUCE_COUNT_TRUE |
Mengurangi dengan menghitung jumlah titik data bernilai True di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dari Boolean value_type. value_type outputnya adalah INT64. |
REDUCE_COUNT_FALSE |
Mengurangi dengan menghitung jumlah titik data bernilai False di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dari Boolean value_type. value_type outputnya adalah INT64. |
REDUCE_FRACTION_TRUE |
Mengurangi dengan menghitung rasio jumlah titik data bernilai True terhadap jumlah total titik data untuk setiap periode penyelarasan. Pengurangan ini valid untuk metrik DELTA dan GAUGE dari Boolean value_type. Nilai output berada dalam rentang [0,0, 1,0] dan memiliki value_type DOUBLE. |
REDUCE_PERCENTILE_99 |
Mengurangi dengan menghitung persentil ke-99 titik data di seluruh deret waktu untuk setiap periode perataan. Pengurangan ini berlaku untuk metrik GAUGE dan DELTA dari jenis numerik dan distribusi. Nilai outputnya adalah DOUBLE. |
REDUCE_PERCENTILE_95 |
Mengurangi dengan menghitung persentil ke-95 titik data di seluruh deret waktu untuk setiap periode penyelarasan. Pengurangan ini berlaku untuk metrik GAUGE dan DELTA dari jenis numerik dan distribusi. Nilai outputnya adalah DOUBLE. |
REDUCE_PERCENTILE_50 |
Mengurangi dengan menghitung persentil ke-50 titik data di seluruh deret waktu untuk setiap periode perataan. Pengurangan ini berlaku untuk metrik GAUGE dan DELTA dari jenis numerik dan distribusi. Nilai outputnya adalah DOUBLE. |
REDUCE_PERCENTILE_05 |
Mengurangi dengan menghitung persentil ke-5 titik data di seluruh deret waktu untuk setiap periode perataan. Pengurangan ini berlaku untuk metrik GAUGE dan DELTA dari jenis numerik dan distribusi. Nilai outputnya adalah DOUBLE. |
ComparisonType
Menentukan hubungan pengurutan pada dua argumen, yang disebut left dan right.
| Enum | |
|---|---|
COMPARISON_UNSPECIFIED |
Tidak ada hubungan pengurutan yang ditentukan. |
COMPARISON_GT |
Benar jika argumen kiri lebih besar daripada argumen kanan. |
COMPARISON_GE |
Benar jika argumen kiri lebih besar dari atau sama dengan argumen kanan. |
COMPARISON_LT |
Benar jika argumen kiri lebih kecil daripada argumen kanan. |
COMPARISON_LE |
Benar jika argumen kiri kurang dari atau sama dengan argumen kanan. |
COMPARISON_EQ |
Benar (True) jika argumen kiri sama dengan argumen kanan. |
COMPARISON_NE |
Benar jika argumen kiri tidak sama dengan argumen kanan. |
EvaluationMissingData
Kontrol kondisi yang menentukan cara kondisi batas metrik dievaluasi saat data berhenti tiba. Kontrol ini tidak memengaruhi kebijakan tidak adanya metrik.
| Enum | |
|---|---|
EVALUATION_MISSING_DATA_UNSPECIFIED |
Opsi data yang tidak ada untuk evaluasi yang tidak ditentukan. Setara dengan EVALUATION_MISSING_DATA_NO_OP. |
EVALUATION_MISSING_DATA_INACTIVE |
Jika tidak ada data untuk mengevaluasi kondisi, maka evaluasi kondisi sebagai salah (false). |
EVALUATION_MISSING_DATA_ACTIVE |
Jika tidak ada data untuk mengevaluasi kondisi, evaluasi kondisi sebagai benar. |
EVALUATION_MISSING_DATA_NO_OP |
Jangan mengevaluasi kondisi ke nilai apa pun jika tidak ada data. |
ConditionCombinerType
Operator untuk menggabungkan kondisi.
| Enum | |
|---|---|
COMBINE_UNSPECIFIED |
Penggabung yang tidak ditentukan. |
AND |
Gabungkan kondisi menggunakan operator logis AND. Insiden dibuat hanya jika semua kondisi terpenuhi secara bersamaan. Penggabung ini terpenuhi jika semua kondisi terpenuhi, meskipun terpenuhi di resource yang sama sekali berbeda. |
OR |
Gabungkan kondisi menggunakan operator logis OR. Insiden dibuat jika salah satu kondisi yang tercantum terpenuhi. |
AND_WITH_MATCHING_RESOURCE |
Gabungkan kondisi menggunakan operator logis AND, tetapi tidak seperti opsi AND biasa, insiden hanya dibuat jika semua kondisi terpenuhi secara bersamaan di setidaknya satu resource. |
NotificationPrompt
Kontrol kapan notifikasi akan dikirim.
| Enum | |
|---|---|
NOTIFICATION_PROMPT_UNSPECIFIED |
Tidak ada strategi yang ditentukan. Diperlakukan sebagai error. |
OPENED |
Memberi tahu saat insiden dibuka. |
CLOSED |
Memberi tahu saat insiden ditutup. |
Keparahan
Enumerasi kemungkinan tingkat keparahan untuk kebijakan pemberitahuan.
| Enum | |
|---|---|
SEVERITY_UNSPECIFIED |
Tingkat keparahan tidak ditentukan. Ini adalah nilai defaultnya. |
CRITICAL |
Ini adalah tingkat keparahan tertinggi. Gunakan opsi ini jika masalah dapat menyebabkan kerusakan atau gangguan yang signifikan. |
ERROR |
Ini adalah tingkat keparahan sedang. Gunakan ini jika masalah dapat menyebabkan kerusakan ringan atau waktu istirahat. |
WARNING |
Ini adalah tingkat keparahan terendah. Gunakan opsi ini jika masalah tidak menyebabkan kerusakan atau periode nonaktif, tetapi berpotensi menimbulkan masalah pada masa mendatang. |
Anotasi Alat
Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌