Mengonfigurasi pemberitahuan berbasis log

Halaman ini menjelaskan cara mengonfigurasi pemberitahuan berbasis log dari Logs Explorer untuk Layanan Pencadangan dan DR di konsol Google Cloud .

Antarmuka Logs Explorer untuk membuat dan mengedit pemberitahuan berbasis log akan memandu Anda melalui langkah-langkah berikut:

  • Berikan nama dan deskripsi untuk pemberitahuan.
  • Pilih log yang notifikasinya ingin Anda terima.
  • Tetapkan waktu antara notifikasi.
  • Tetapkan waktu untuk penutupan insiden secara otomatis.
  • Tentukan siapa yang akan diberi tahu.

Izin dan peran

Untuk membuat dan mengelola pemberitahuan berbasis log, peran Identity and Access Management (IAM) Anda harus menyertakan izin yang dijelaskan dalam Izin untuk pemberitahuan berbasis log.

Membuat pemberitahuan berbasis log

Untuk mengirim notifikasi pemberitahuan, Anda harus memiliki saluran notifikasi. Anda dapat membuat saluran notifikasi sebelum membuat peringatan atau saat membuat peringatan.

Untuk membuat pemberitahuan berbasis log, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud , pilih Logging, lalu Logs Explorer.
  2. Gunakan panel Kueri untuk menentukan peristiwa yang ingin Anda terima notifikasinya. Anda dapat menggunakan contoh kueri yang ditampilkan di contoh kueri di panel kueri untuk mengonfigurasi pemberitahuan.

    Berikut adalah contoh kueri untuk mendapatkan notifikasi tentang peristiwa dengan ID peristiwa tertentu.

    logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events"
    jsonPayload.eventId=10046
    
  3. Di header panel Query results, klik Create alert. Jika jendela Anda terlalu sempit, opsi Buat pemberitahuan akan muncul di menu Tindakan.

  4. Di panel Detail pemberitahuan, beri nama dan deskripsi pada pemberitahuan:

    1. Masukkan nama untuk pemberitahuan Anda di kolom Alert Policy Name. Nama ini ditampilkan di header notifikasi.
    2. Di kolom Dokumentasi, masukkan deskripsi untuk pemberitahuan. Untuk mengetahui informasi tentang cara memformat dan meningkatkan kualitas konten kolom ini, lihat Menggunakan Markdown dan variabel dalam template dokumentasi. Sebaiknya sertakan URL konsol pengelolaan di kolom dokumentasi. Anda juga dapat menambahkan solusi untuk menyelesaikan peristiwa.
  5. Klik Berikutnya.

  6. Di panel Choose logs to include in the alert, lakukan hal berikut:

    1. Periksa kueri dan hasilnya dengan mengklik Pratinjau log. Anda juga dapat mengedit kueri di panel ini, jika perlu.
    2. Anda dapat menambahkan label untuk menyesuaikan notifikasi dan membuatnya lebih informatif. Klik Tambahkan label, lalu lakukan tindakan berikut:

      1. Masukkan Nama tampilan untuk label.
      2. Pilih Nama kolom log dari daftar. Kolom ini ditampilkan berdasarkan hasil kueri yang dipilih.
      3. Masukkan Regular expression untuk mengekstrak nilai dari kolom yang harus berisi persis satu grup ekspresi reguler.
  7. Klik Berikutnya.

  8. Pilih waktu minimum antarnotifikasi. Nilai ini memungkinkan Anda mengontrol jumlah notifikasi yang Anda dapatkan dari pemberitahuan ini jika dipicu beberapa kali. Misalnya, Anda dapat memilih 5 menit dari opsi untuk membatasi notifikasi menjadi setiap lima menit. Anda dapat menyesuaikan durasi penutupan insiden otomatis dengan memilih opsi di menu jika berlaku.

  9. Klik Berikutnya.

  10. Pilih satu atau beberapa saluran notifikasi untuk pemberitahuan Anda, misalnya, pilih saluran notifikasi email. Jika sudah mengonfigurasi saluran notifikasi email, Anda dapat memilihnya dari daftar. Jika tidak, klik Kelola saluran notifikasi dan tambahkan saluran email. Untuk informasi tentang cara membuat saluran notifikasi, lihat Mengelola saluran notifikasi.

  11. Klik Simpan.

    Sebaiknya konfigurasikan pemberitahuan untuk ID Peristiwa penting.

Menguji pemberitahuan berbasis log

Untuk menguji pemberitahuan berbasis log yang Anda buat, Anda dapat menulis entri log yang cocok dengan kueri secara manual. Untuk menulis entri log, ikuti langkah-langkah berikut:

  1. Buka halaman referensi logEntries.write, atau klik tombol berikut:

    Buka logEntries.write

  2. Konfigurasikan entri log berikut dengan mengubah variabel PROJECT_ID ke project ID Anda. Jika kebijakan pemberitahuan menyertakan atau mengecualikan ID peristiwa tertentu, Anda juga harus mengubah ID peristiwa:

      "entries": [
      {
        "jsonPayload": {
          "eventId": 10046,
          "errorMessage": "this is a manually generated error message created for testing"
        },
        "resource": {
          "type": "backupdr.googleapis.com/BackupRecoveryAppliance",
        },
        "severity": "ERROR",
        "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events",
      }
      ]
    
  3. Salin entri log yang telah Anda konfigurasi sebelumnya.

  4. Di panel Coba API ini, ikuti langkah-langkah berikut:

    1. Ganti konten di kolom Isi permintaan di APIs Explorer dengan entri log yang Anda salin di langkah sebelumnya.
    2. Klik Jalankan. Jika diminta, ikuti alur autentikasi.

    Jika panggilan logEntries.write berhasil, Anda akan mendapatkan kode respons HTTP 200 dan isi respons kosong, {}. Untuk informasi selengkapnya tentang APIs Explorer, lihat Menggunakan APIs Explorer. APIs Explorer berfungsi dengan cara yang sama dengan Logging API.

    Entri log cocok dengan filter yang ditentukan untuk pemberitahuan dengan cara berikut:

    • Nilai logName menentukan login peristiwa perangkat cadangan/pemulihan untuk project Cloud Anda.
    • Nilai tingkat keparahan untuk entri log ini adalah ERROR.
    • jsonPayload berisi peristiwa kapasitas penuh kumpulan 10046.

    Setelah Anda menulis entri log, urutan berikut akan terjadi:

    1. Entri log baru akan muncul di "Logs Explorer dan memicu pemberitahuan.
    2. Insiden akan terbuka di Cloud Monitoring.
    3. Anda akan menerima notifikasi untuk insiden tersebut. Jika Anda mengonfigurasi saluran notifikasi email, notifikasi akan ditampilkan.

Anda dapat mengklik Lihat insiden di email untuk melihat insiden di Cloud Monitoring. Untuk informasi selengkapnya tentang insiden, termasuk cara mengonfirmasi dan menutupnya, lihat Mengelola insiden untuk pemberitahuan berbasis log.

Membuat beberapa kebijakan pemberitahuan

Sebaiknya buat kebijakan pemberitahuan berdasarkan prioritas dan urgensi peristiwa. Dari perspektif pemberitahuan, peristiwa dapat dikategorikan secara luas ke dalam kategori berikut:

  1. Peristiwa yang harus segera dihadiri sehingga memerlukan notifikasi yang lebih sering. Misalnya, ID peristiwa 43901 (tugas snapshot gagal) perlu dilaporkan setiap 30 menit. Gunakan kueri berikut untuk membuat pemberitahuan.

        Policyname = 'Snapshot job has failed'
        Notification rate limit = 30 min
        logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND jsonPayload.eventId=43901
    
  2. Peristiwa yang kurang mendesak sehingga memerlukan notifikasi yang lebih jarang. Misalnya, ID peristiwa 10085 (pelanggaran rencana pencadangan) hanya perlu dilaporkan satu kali per hari. Gunakan kueri berikut untuk membuat pemberitahuan.

        Policyname = 'Backup Plan Violation has occurred'
        Notification rate limit = 1 day
        logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND jsonPayload.eventId=10085
    
  3. Peristiwa yang tidak berdampak dan dapat diabaikan. Misalnya, ID peristiwa 10229 (error penyimpanan terlampaui) dan 42356 (perubahan file telah terdeteksi) dapat diabaikan, karena dukungan Google telah menyatakan bahwa keduanya merupakan positif palsu. Gunakan kueri berikut untuk membuat pemberitahuan.

        Policyname = 'Backup/DR event has occurred'
        Notification rate limit = 6 hr
        logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND NOT jsonPayload.eventId=(10085 OR 10229 OR 42356 OR 43901)