Membuat dan mengelola penundaan

Dokumen ini menjelaskan cara membuat dan mengelola penundaan. Penundaan akan mencegah Cloud Monitoring membuat insiden dan mengeluarkan notifikasi selama jangka waktu tertentu. Setiap penundaan menentukan resource yang berlaku.

Untuk ringkasan konseptual, lihat Menunda notifikasi dan insiden.

Untuk membuat dan mengelola penundaan, Anda menggunakan konsol Google Cloud atau Cloud Monitoring API.

Sebelum memulai

  1. Pastikan Anda memiliki izin yang diperlukan:

    Untuk informasi selengkapnya tentang peran Cloud Monitoring, lihat Mengontrol akses dengan Identity and Access Management.

  2. Jika Anda ingin menggunakan contoh Cloud Monitoring API dalam dokumen ini, lakukan hal berikut:

    1. Buat variabel lingkungan, PROJECT_ID, untuk menyimpan ID project Google Cloud Anda:

      PROJECT_ID=PROJECT_ID

    2. Lakukan autentikasi ke Google Cloud CLI:

      gcloud auth login

    3. Tetapkan project Google Cloud default:

      gcloud config set project ${PROJECT_ID}

    4. 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 kembali perintah ini.

Membuat penundaan

Untuk mencegah kebijakan pemberitahuan membuat insiden dan mengirim notifikasi, buat penundaan.

Anda dapat membuat penundaan menggunakan konsol Google Cloud, gcloud CLI, atau Cloud Monitoring API.

console

  1. Di konsol Google Cloud, buka halaman  Alerting:

    Buka Pemberitahuan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Untuk membuat penundaan dari insiden yang terbuka, lakukan hal berikut:
    1. Di panel Insiden pada halaman Pemberitahuan, temukan insiden Anda, lalu klik Ringkasan insiden.
    2. Di halaman Detail insiden, klik Tunda, lalu pilih durasi penundaan. Anda tidak dapat mengonfigurasi kolom lain.

  3. Jika tidak, lakukan yang berikut ini:

    1. Di halaman Alerting, klik Create snooze.
    2. Masukkan nama deskriptif untuk penundaan. Nama ini ditampilkan di halaman Alerting.
    3. Pilih Waktu mulai. Anda dapat memasukkan waktu tertentu atau memulai penundaan saat penundaan dibuat.
    4. Masukkan Durasi. Nilai kolom ini menentukan durasi tunda.

    5. Lengkapi bagian Kriteria penundaan. Anda dapat menggunakan menu Kebijakan pemberitahuan untuk memilih kebijakan pemberitahuan yang akan diterapkan penundaan.

      Anda dapat menambahkan hingga 16 kebijakan pemberitahuan ke penundaan.

      Setelah Anda menyelesaikan bagian Kriteria penundaan, panel Buat penundaan akan mencantumkan insiden sebelumnya yang cocok dengan kriteria.

    6. 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 lama 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 akan membuat penundaan dengan nama tampilan "Maintenance Week". Penundaan berlaku untuk dua kebijakan pemberitahuan dan mencakup interval waktu dari 1 Maret hingga 7 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 untuk perintah ini akan mirip 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 tindakan berikut:

  • Jalankan perintah gcloud alpha monitoring policies list. Data respons perintah ini mencakup nama kebijakan pemberitahuan Anda.
  • Melihat representasi JSON kebijakan pemberitahuan. Anda dapat mendownload representasi JSON ke sistem lokal menggunakan opsi di halaman Detail kebijakan.

Membuat penundaan berulang

Untuk membuat penundaan yang terjadi selama 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 diperlukan.

Mencantumkan penundaan

Saat Anda membuat penundaan, penundaan tersebut akan ditambahkan ke histori penundaan untuk project Anda. Data ini menampilkan penundaan yang sudah tidak berlaku, aktif, dan mendatang. Anda tidak dapat menghapus entri dari data ini, yaitu, Anda tidak dapat menghapus penundaan. Namun, dari tampilan ini, Anda dapat menampilkan detail tentang penundaan dan Anda dapat melakukan tindakan seperti mengedit atau menyalin penundaan.

console

Untuk melihat daftar penundaan, lakukan tindakan berikut:

  1. Di konsol Google Cloud, buka halaman  Alerting:

    Buka Pemberitahuan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik Lihat semua penundaan di panel Tunda.

    Halaman Tunda menampilkan daftar penundaan dan linimasa yang menampilkan penundaan Anda sebelumnya, mendatang, dan yang aktif secara grafis.

    • Untuk mengedit, menyalin, membatalkan, atau mengakhiri penundaan, gunakan menu Opsi lainnya untuk penundaan. Status penundaan menentukan opsi yang tersedia.
    • Untuk mencantumkan semua penundaan, aktifkan Tampilkan penundaan sebelumnya. Secara default, hanya penundaan yang aktif dan mendatang yang dicantumkan.
    • Untuk mengubah periode tampilan tabel Linimasa, gunakan menu Rentang waktu. Secara default, tabel menampilkan data untuk satu jam ke depan; tetapi, Anda dapat mengubah kolom ini untuk menentukan rentang waktu sebelumnya atau mendatang. Penundaan yang sudah habis masa berlakunya akan disimpan selama 13 bulan.
    • Untuk melihat detail tentang penundaan tertentu, klik Lihat detail.
    • Untuk melihat ringkasan penundaan aktif, tempatkan kursor di area yang diarsir pada baris Aktif di tabel Linimasa. Tooltip akan menampilkan informasi ringkasan.
    • Untuk melihat representasi grafis penundaan aktif, luaskan baris Active pada tabel Timeline.

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 menampilkan daftar objek snooze. Misalnya, saat project memiliki satu penundaan, respons terhadap perintah snoozes.list akan mirip 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 mencantumkan penundaan di project Anda saat ini, jalankan perintah gcloud monitoring snoozes list:

gcloud monitoring snoozes list OPTIONAL_FLAGS

Untuk informasi tentang flag opsional, lihat halaman referensi gcloud monitoring snoozes list.

Respons untuk 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, responsnya 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, dan Anda dapat mengedit nama dan waktu akhir penundaan yang aktif. Misalnya, saat masa pemeliharaan dijadwalkan ulang, Anda mungkin perlu mengedit penundaan.

Anda tidak dapat mengedit penundaan sebelumnya atau kriteria penundaan apa pun. Namun, jika Anda ingin menjadwalkan penundaan sebelumnya untuk jangka waktu mendatang, salin penundaan dan terapkan perubahan pada salinan sebelum Anda memilih Buat.

console

Untuk mengedit penundaan, lakukan tindakan berikut:

  1. Di konsol Google Cloud, buka halaman  Alerting:

    Buka Pemberitahuan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik Lihat semua penundaan di panel Tunda.
  3. Dalam daftar penundaan, temukan penundaan yang ingin Anda edit, lalu pilih Edit penundaan di menu Opsi lainnya.
  4. 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 telah direvisi dan menyertakan parameter kueri yang mengidentifikasi kolom yang diubah. Saat menggunakan curl, parameter kueri harus dienkode URL.

Untuk penundaan mendatang, Anda dapat mengubah nama dan periodenya. Untuk penundaan aktif, Anda dapat mengubah nama dan waktu berakhir. Anda tidak dapat mengubah penundaan sebelumnya.

Untuk memperbarui displayName penundaan, buat file JSON, my-updated-snooze.json, yang mendeskripsikan objek penundaan dan memperbarui nama tampilan. Kemudian, 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 akhir:

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, jika pemeliharaan terencana selesai lebih cepat dari yang diperkirakan, Anda mungkin ingin mengakhiri penundaan.

Jika Anda memiliki penundaan mendatang yang tidak ingin digunakan lagi, batalkan penundaan. Operasi pembatalan menetapkan durasi ke nol dan menyebabkan penundaan bertransisi ke status Lama.

console

Untuk mengakhiri penundaan yang aktif atau membatalkan penundaan mendatang, lakukan tindakan berikut:

  1. Di konsol Google Cloud, buka halaman  Alerting:

    Buka Pemberitahuan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik Lihat semua penundaan di panel Tunda.

  3. Dalam daftar penundaan, temukan penundaan yang ingin Anda akhiri atau batalkan, lalu lakukan salah satu hal berikut:

    • Untuk mengakhiri penundaan yang aktif, pilih Akhiri sekarang di menu Opsi lainnya .
    • Untuk membatalkan penundaan mendatang, pilih Cancel snooze di menu More options .

Cloud Monitoring API

Untuk mengakhiri penundaan yang aktif, edit penundaan dan tetapkan waktu berakhir ke waktu saat ini. Untuk mengetahui 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 mengetahui informasi selengkapnya, lihat Mengedit penundaan.

gcloud CLI

Untuk mengakhiri penundaan yang 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 lain, buat salinan. Saat Anda menyalin penundaan, editor penundaan akan terbuka dengan semua kolom kecuali waktu mulai yang ditetapkan ke nilai dalam penundaan asli. Anda dapat mengubah semua kolom sebelum mengklik Buat.

Untuk menyalin penundaan menggunakan konsol, lakukan hal berikut:

  1. Di konsol Google Cloud, buka halaman  Alerting:

    Buka Pemberitahuan

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik Lihat semua penundaan di panel Tunda.
  3. Dalam daftar penundaan, temukan penundaan yang ingin Anda edit, lalu pilih Salin penundaan di menu Opsi lainnya .
  4. Terapkan perubahan pada salinan, lalu klik Buat.

Langkah selanjutnya