Dokumen ini menjelaskan cara membuat dan mengelola penundaan. Penundaan mencegah Cloud Monitoring membuat insiden dan mengeluarkan notifikasi selama jangka waktu tertentu. Setiap penundaan menentukan resource yang diterapkan.
Untuk ringkasan konseptual, lihat Menunda notifikasi dan pemberitahuan.
Untuk membuat dan mengelola penundaan, Anda dapat menggunakan Konsol Google Cloud atau Cloud Monitoring API.
Sebelum memulai
Pastikan Anda memiliki izin yang diperlukan:
-
Untuk mendapatkan izin yang diperlukan untuk melihat dan mengedit penundaan dengan menggunakan Konsol Google Cloud, minta administrator untuk memberi Anda peran IAM Monitoring Editor (
roles/monitoring.editor) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses.Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
-
Untuk mendapatkan izin yang diperlukan untuk melihat dan mengedit penundaan dengan menggunakan Cloud Monitoring API, minta administrator untuk memberi Anda peran IAM Monitoring Tunda Editor (
roles/monitoring.snoozeEditor) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses.Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Untuk mengetahui informasi selengkapnya tentang peran Cloud Monitoring, lihat Mengontrol akses dengan Identity and Access Management.
-
Jika Anda ingin menggunakan contoh Cloud Monitoring API dalam dokumen ini, lakukan hal berikut:
Buat variabel lingkungan,
PROJECT_ID, untuk menyimpan ID project Google Cloud Anda:PROJECT_ID=PROJECT_ID
Autentikasi ke Google Cloud CLI:
gcloud auth login
Tetapkan project Google Cloud default:
gcloud config set project ${PROJECT_ID}
Buat token otorisasi:
ACCESS_TOKEN=`gcloud auth print-access-token`
Anda harus memperbarui token akses secara berkala. Jika perintah yang berfungsi tiba-tiba melaporkan bahwa Anda tidak diautentikasi, terbitkan ulang perintah ini.
Buat tidur sebentar
Untuk mencegah kebijakan pemberitahuan membuat insiden dan mengirim notifikasi, buat tunda.
Anda dapat membuat tunda dengan menggunakan Konsol Google Cloud, gcloud CLI, atau Cloud Monitoring API.
console
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih notifications Alerting:
- Untuk membuat penundaan dari insiden terbuka, lakukan tindakan berikut:
- Di panel Insiden di halaman Alerting, temukan insiden Anda dan klik Incident summary.
- Di halaman Incident details, klik Tunda, lalu pilih durasi tunda. Anda tidak dapat mengonfigurasi kolom lain.
Jika tidak, lakukan yang berikut ini:
- Di halaman Alerting, klik Create Delay.
- Masukkan nama deskriptif untuk penundaan. Nama ini ditampilkan di halaman Alerting.
- Pilih Waktu mulai. Anda dapat memasukkan waktu tertentu atau memulai penundaan saat penundaan dibuat.
- Masukkan Durasi. Nilai kolom ini menentukan durasi penundaan.
Lengkapi bagian Kriteria Tunda. Anda dapat menggunakan menu Alert policy untuk memilih kebijakan pemberitahuan yang menerapkan penundaan.
Anda dapat menambahkan hingga 16 kebijakan pemberitahuan ke penundaan.
Setelah Anda menyelesaikan bagian Kriteria Tunda, panel Buat tunda akan mencantumkan insiden terdahulu yang cocok dengan kriteria.
Klik Create.
Cloud Monitoring API
Untuk membuat penundaan, panggil metode snoozes.create
dengan mengeluarkan permintaan POST ke endpoint Snooze.
Anda harus menyediakan objek snooze:
curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes
Metode ini menampilkan objek snooze. Kolom "name", yang menyertakan ID penundaan yang dihasilkan oleh Monitoring, adalah satu-satunya perbedaan antara objek yang ditampilkan dan konten my-snooze.json:
{
"name": "projects/my-project/snoozes/2986666341878464512",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-12T19:00:20Z",
"endTime": "2022-11-12T19:05:20Z"
},
"displayName": "Snooze2"
}
gcloud CLI
Untuk membuat penundaan, jalankan
perintah gcloud monitoring snoozes create:
gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME
Pada perintah sebelumnya, end-time harus setidaknya satu menit lebih lambat
dari start-time. Anda harus mengikuti aturan pemformatan ISO 8601; tetapi,
Anda dapat menentukan waktu absolut atau relatif. Contoh berikut menentukan waktu absolut. Untuk memulai penundaan 30 menit dari waktu saat ini, gunakan
--start-time="+PTM30M".
Jika Anda menentukan beberapa project, pisahkan project dengan koma.
Misalnya, perintah berikut membuat penundaan dengan nama tampilan "Minggu Pemeliharaan". Penundaan berlaku untuk dua kebijakan pemberitahuan dan mencakup interval waktu dari tanggal satu Maret hingga ketujuh Maret:
gcloud monitoring snoozes create --display-name="Maintenance Week" \
--criteria-policies="projects/my-project/alertPolicies/12345,projects/my-project/alertPolicies/23451" \
--start-time="2023-03-01T03:00:00.0-0500" \
--end-time="2023-03-07T23:59:59.5-0500"
Contoh sebelumnya membuat penundaan berikut di my-project:
{
"name": "projects/my-project/snoozes/98765",
"displayName": "Maintenance Week",
"interval": {
"startTime": "2023-03-01T08:00:00Z",
"endTime": "2023-03-08T04:59:59Z"
},
"criteria": {
"policies": [
"projects/my-project/alertPolicies/12345",
"projects/my-project/alertPolicies/23451",
]
}
}
Jika berhasil, respons terhadap perintah ini serupa dengan berikut ini:
Created snooze [projects/my-project/snoozes/98765]
Nama kebijakan pemberitahuan tidak ditampilkan di Konsol Google Cloud. Untuk menentukan nama kebijakan pemberitahuan, lakukan salah satu hal berikut:
- Jalankan perintah
gcloud alpha monitoring policies list. Data respons perintah ini menyertakan nama kebijakan pemberitahuan Anda. - Melihat representasi JSON dari kebijakan pemberitahuan. Anda dapat mendownload representasi JSON ke sistem lokal menggunakan opsi di halaman Detail kebijakan.
Buat penundaan berulang
Untuk membuat penundaan yang terjadi pada interval berulang, Anda dapat menulis skrip yang membuat penundaan untuk kebijakan pemberitahuan. Kemudian, gunakan penjadwal tugas seperti cron atau Cloud Scheduler untuk menjalankan skrip sesuai jadwal yang Anda perlukan.
Mencantumkan penundaan
Saat Anda membuat penundaan, penundaan ini akan ditambahkan ke catatan historis penundaan untuk project Anda. Data ini menampilkan penundaan yang habis masa berlakunya, aktif, dan yang akan datang. Anda tidak dapat menghapus entri dari catatan ini, artinya, Anda tidak dapat menghapus penundaan. Namun, dari tampilan ini, Anda dapat menampilkan detail tentang penundaan dan dapat melakukan tindakan seperti mengedit atau menyalin penundaan.
console
Untuk melihat daftar penundaan, lakukan hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih notifications Alerting:
Klik Lihat semua penundaan di panel Tunda.
Halaman Tunda menampilkan daftar penundaan dan linimasa yang secara grafis menampilkan penundaan sebelumnya, yang akan datang, dan penundaan aktif.
- Untuk mengedit, menyalin, membatalkan, atau mengakhiri penundaan, gunakan menu more_vert Opsi lainnya untuk menunda. Status penundaan menentukan opsi yang tersedia.
- Untuk mencantumkan semua tunda, aktifkan Tampilkan tunda sebelumnya. Secara default, hanya penundaan aktif dan mendatang yang dicantumkan.
- Untuk mengubah periode tampilan untuk tabel Linimasa, gunakan menu Rentang waktu. Secara default, tabel menampilkan data untuk satu jam ke depan. Namun, Anda dapat mengubah kolom ini untuk menentukan rentang waktu sebelumnya atau yang akan datang. Penundaan yang habis masa berlakunya akan dipertahankan selama 13 bulan.
- Untuk melihat detail tentang penundaan tertentu, klik Lihat detail.
- Untuk melihat ringkasan penundaan aktif, tempatkan kursor di area berarsir baris Active di tabel Timeline. Tooltip akan menampilkan informasi ringkasan.
- Untuk melihat representasi grafis dari penundaan aktif, luaskan baris Active di tabel Linimasa.
Cloud Monitoring API
Untuk mencantumkan semua penundaan yang termasuk dalam project Google Cloud, panggil metode snoozes.list:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes
Metode ini akan menampilkan daftar objek snooze. Misalnya,
jika project memiliki satu penundaan, respons terhadap perintah snoozes.list
akan serupa dengan berikut ini:
{
"snoozes": [
{
"name": "projects/my-project/snoozes/2986663705844383744",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-08T19:00:20Z",
"endTime": "2022-11-08T19:05:20Z"
},
"displayName": "Snooze1"
}
]
}
Untuk mendapatkan informasi tentang penundaan tertentu, panggil metode snoozes.get dan tentukan project ID dan ID penundaan. Dalam respons sebelumnya,
ID penundaan adalah 2986663705844383744:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}
Metode ini menampilkan satu objek snooze:
{
"name": "projects/my-project/snoozes/2986663705844383744",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-08T19:00:20Z",
"endTime": "2022-11-08T19:05:20Z"
},
"displayName": "Snooze1"
}
gcloud CLI
Untuk menampilkan daftar penundaan dalam project saat ini, jalankan perintah gcloud monitoring snoozes list:
gcloud monitoring snoozes list OPTIONAL_FLAGS
Untuk mengetahui informasi tentang flag opsional, lihat
halaman referensi gcloud monitoring snoozes list.
Respons terhadap perintah ini adalah daftar nama penundaan
dalam project, yang diformat sebagai YAML. Misalnya, respons terhadap perintah ini untuk project Google Cloud dengan ID my-project adalah satu entri:
criteria: policies: - projects/my-project/alertPolicies/12345 - projects/my-project/alertPolicies/23451 displayName: Maintenance Week interval: endTime: '2023-03-08T04:59:59Z' startTime: '2023-03-01T08:00:00Z' name: projects/my-project/snoozes/98765
Untuk mencantumkan detail tentang penundaan tertentu, jalankan perintah gcloud monitoring snoozes describe:
gcloud monitoring snoozes describe NAME
Misalnya, untuk menampilkan detail tentang penundaan dengan nama
projects/my-project/snoozes/98765, jalankan perintah berikut:
gcloud monitoring snoozes describe projects/my-project/snoozes/98765
Jika Anda memberikan NAME yang tidak valid ke perintah describe, respons akan berisi kode error 500 dan pesan berikut:
Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.
Mengedit penundaan
Anda dapat mengedit nama dan periode penundaan mendatang, serta mengedit nama dan waktu berakhir penundaan aktif. Misalnya, saat masa pemeliharaan dijadwalkan ulang, Anda mungkin perlu mengedit penundaan.
Anda tidak dapat mengedit penundaan yang lewat atau kriteria penundaan apa pun. Namun, jika Anda ingin menjadwalkan penundaan yang lalu untuk jangka waktu yang akan datang, salin penundaan tersebut dan terapkan perubahan pada salinan sebelum Anda memilih Buat.
console
Untuk mengedit penundaan, lakukan hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih notifications Alerting:
- Klik Lihat semua penundaan di panel Tunda.
- Dalam daftar tunda, temukan penundaan yang ingin Anda edit, lalu pilih Edit Ditunda di menu more_vert More options.
- Klik Simpan setelah Anda menyelesaikan perubahan.
Cloud Monitoring API
Untuk mengubah penundaan yang ada, panggil metode snoozes.patch
dengan mengeluarkan permintaan PATCH ke endpoint Snooze.
Anda harus memberikan objek snooze yang direvisi dan menyertakan parameter kueri yang mengidentifikasi kolom mana yang dimodifikasi. Saat menggunakan curl, parameter kueri harus dienkode ke URL.
Untuk penundaan mendatang, Anda dapat mengubah nama dan periode. Untuk penundaan aktif, Anda dapat mengubah nama dan waktu berakhir. Anda tidak dapat mengubah waktu tunda yang lalu.
Untuk memperbarui displayName penundaan, buat file JSON,
my-updated-snooze.json, yang menjelaskan objek tunda dan memperbarui
nama tampilan. Lalu, jalankan perintah berikut:
curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName
Metode ini menampilkan objek snooze yang identik dengan
konten file my-updated-snooze.json:
{
"name": "projects/my-project/snoozes/2986665388391530496",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/7164333552684403347"
]
},
"interval": {
"startTime": "2022-11-08T22:26:05Z",
"endTime": "2022-11-08T22:31:05Z"
},
"displayName": "Updated snooze name"
}
gcloud CLI
Untuk mengedit penundaan, jalankan
perintah gcloud monitoring snoozes update. Anda dapat memperbarui
nama tampilan, waktu mulai, dan waktu berakhir:
gcloud monitoring snoozes update NAME OPTIONAL_FLAGS
Untuk mengetahui daftar opsi perintah update, lihat
halaman referensi gcloud monitoring snoozes update.
Misalnya, untuk mengubah nama tampilan penundaan dengan nama
projects/my-project/snoozes/98765, jalankan perintah berikut:
gcloud monitoring snoozes update projects/my-project/snoozes/98765 --display-name="March Maintenance"
Mengakhiri atau membatalkan penundaan
Jika Anda ingin menerima notifikasi untuk resource yang cocok dengan kriteria yang ditentukan dalam penundaan aktif, akhiri penundaan. Misalnya, saat pemeliharaan terencana selesai lebih cepat dari yang diperkirakan, sebaiknya hentikan penundaan.
Jika Anda memiliki penundaan mendatang yang tidak lagi diinginkan, batalkan penundaan tersebut. Operasi pembatalan menetapkan durasi ke nol dan menyebabkan penundaan transisi ke status Past.
console
Untuk mengakhiri penundaan aktif atau membatalkan penundaan mendatang, lakukan hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih notifications Alerting:
- Klik Lihat semua penundaan di panel Tunda.
Dalam daftar penundaan, temukan penundaan yang ingin Anda akhiri atau batalkan, lalu lakukan salah satu hal berikut:
- Untuk mengakhiri penundaan aktif, pilih Akhiri sekarang di menu more_vert Opsi lainnya.
- Untuk membatalkan penundaan mendatang, pilih Batalkan tunda di menu more_vert Opsi lainnya.
Cloud Monitoring API
Untuk mengakhiri penundaan aktif, edit penundaan dan tetapkan waktu berakhir ke waktu saat ini. Untuk informasi selengkapnya, lihat Mengedit penundaan.
Untuk membatalkan penundaan mendatang, edit penundaan dan tetapkan waktu berakhir ke waktu mulai penundaan. Waktu mulai harus di masa mendatang. Untuk informasi selengkapnya, lihat Mengedit penundaan.
gcloud CLI
Untuk mengakhiri penundaan aktif atau membatalkan penundaan mendatang, jalankan
perintah gcloud monitoring snoozes cancel:
gcloud monitoring snoozes cancel NAME
Misalnya, untuk membatalkan penundaan dengan nama
projects/my-project/snoozes/98765, jalankan perintah berikut:
gcloud monitoring snoozes cancel projects/my-project/snoozes/98765
Menyalin penundaan
Jika Anda ingin menggunakan penundaan yang ada sebagai template untuk penundaan lainnya, buat salinan. Saat Anda menyalin fitur tunda, editor tunda akan terbuka dengan semua kolom kecuali waktu mulai yang ditetapkan ke nilai dalam penundaan awal. Anda dapat mengubah semua kolom sebelum mengklik Buat.
Untuk menyalin penundaan menggunakan konsol, lakukan hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih notifications Alerting:
- Klik Lihat semua penundaan di panel Tunda.
- Dalam daftar penundaan, temukan penundaan yang ingin Anda edit, lalu pilih Salin tunda di menu more_vert Opsi lainnya.
- Terapkan perubahan pada salinan, lalu klik Buat.
Langkah selanjutnya
Untuk mengetahui ringkasan pemberitahuan, lihat Ringkasan pemberitahuan.
Untuk mengetahui informasi tentang latensi notifikasi dan bagaimana pilihan parameter kebijakan pemberitahuan memengaruhi waktu notifikasi dikirim, lihat Perilaku kebijakan pemberitahuan berbasis metrik.
Untuk mengetahui informasi tentang insiden, lihat dokumen berikut: