Mengonfigurasi pemberitahuan berbasis log untuk resource yang disimpan di vault

Halaman ini menjelaskan cara mengonfigurasi pemberitahuan berbasis log untuk resource yang diamankan dari halaman Log Explorer di konsol Google Cloud .

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

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

Anda dapat mengonfigurasi pemberitahuan untuk kategori tugas pencadangan dan pemulihan: SCHEDULED_BACKUP, ON_DEMAND_BACKUP, dan RESTORE.

Anda juga dapat mengonfigurasi pemberitahuan untuk kategori tugas rencana cadangan dan pengaitan rencana cadangan: UPDATE.

Status tugas yang tersedia adalah: SUCCESSFUL, FAILED, SKIPPED, dan RUNNING.

Anda dapat mengonfigurasi satu atau beberapa saluran notifikasi, seperti Google Chat, email, SMS, atau saluran program chat, untuk menerima notifikasi saat terjadi pemberitahuan. Untuk mengetahui petunjuknya, lihat Membuat dan mengelola saluran notifikasi.

Sebelum memulai

Membuat pemberitahuan berbasis log

Untuk memberi tahu adanya pemberitahuan, Anda harus memiliki saluran notifikasi. Anda dapat membuat saluran notifikasi sebelum membuat pemberitahuan atau saat membuat pemberitahuan.

Gunakan petunjuk berikut untuk membuat pemberitahuan berbasis log.

  1. Di konsol Google Cloud , buka halaman Logs Explorer.

    Buka Logs Explorer

  2. Di panel Kueri, tentukan pemberitahuan yang ingin Anda terima.

    • Kueri berikut adalah contoh untuk mendapatkan notifikasi setiap kali tugas pencadangan terjadwal gagal.

      logName="projects/PROJECT_ID/logs/backupdr.googleapis.com/LOG_NAME"
jsonPayload.jobCategory="SCHEDULED_BACKUP"
jsonPayload.jobStatus="FAILED"

      Ganti kode berikut:

      • PROJECT_ID: nama project.

      • LOG_NAME: nama log, baik:

        • bdr_backup_plan_jobs: tugas yang terkait dengan rencana pencadangan
        • bdr_backup_plan_association_jobs: tugas terkait pengaitan rencana pencadangan di project administrator, jika ada perlindungan lintas project.
        • bdr_backup_plan_association_source_jobs: tugas yang terkait dengan pengaitan rencana cadangan di project beban kerja.

  3. Di header panel Query results, klik Create alert.

  4. Di bagian Detail pemberitahuan, lakukan hal berikut:

    1. Di kolom Nama Kebijakan Pemberitahuan, masukkan nama untuk pemberitahuan Anda. Nama ini akan ditampilkan di header notifikasi.
    2. Di kolom Dokumentasi, masukkan deskripsi untuk pemberitahuan. Untuk informasi tentang cara memformat dan menyempurnakan konten kolom ini, lihat Menggunakan Markdown dan variabel dalam template dokumentasi.

  5. Klik Berikutnya.

  6. Di bagian Pilih log yang akan disertakan dalam pemberitahuan, lakukan hal berikut:

    1. Klik Pratinjau log untuk memeriksa kueri dan hasilnya. Anda juga dapat mengedit kueri di panel ini, jika perlu.

    2. Klik Tambahkan label, lalu lakukan tindakan berikut. Label memungkinkan Anda menyesuaikan notifikasi dan membuatnya lebih informatif.

      1. Di kolom Nama tampilan, masukkan nama untuk label.
      2. Dari daftar Nama kolom log, pilih nama kolom log. Kolom ini ditampilkan berdasarkan hasil kueri yang dipilih.
      3. Di kolom Regular expression, masukkan ekspresi untuk mengekstrak nilai dari kolom yang harus berisi tepat satu grup ekspresi reguler.

  7. Klik Berikutnya.

  8. Di bagian Setel frekuensi notifikasi dan durasi penutupan otomatis, lakukan hal berikut:

    1. Dari daftar Waktu antara notifikasi, pilih waktu minimum antara notifikasi. Nilai ini memungkinkan Anda mengontrol jumlah notifikasi yang Anda dapatkan dari pemberitahuan ini jika dipicu beberapa kali.
    2. Dari daftar Durasi penutupan insiden otomatis, pilih durasi setelah insiden ditutup secara otomatis jika tidak ada entri log yang cocok.

  9. Klik Berikutnya.

  10. Dari daftar Saluran notifikasi, pilih satu atau beberapa saluran notifikasi untuk pemberitahuan Anda. Jika Anda belum mengonfigurasi saluran notifikasi, klik Kelola saluran notifikasi untuk membuatnya. Untuk mengetahui petunjuknya, lihat Membuat dan mengelola saluran notifikasi.

  11. Klik Simpan.

Menguji pemberitahuan berbasis log

Untuk menguji pemberitahuan berbasis log yang Anda buat, Anda dapat menulis entri log secara manual yang cocok dengan kueri.

Gunakan petunjuk berikut untuk menulis entri log.

  1. Buka halaman referensi logEntries.write.

    Buka logEntries.write

  2. Konfigurasi entri log berikut dengan mengubah variabel PROJECT_ID ke project ID Anda.

          {
        "entries": [
          {
            "jsonPayload": {
              "jobCategory": "SCHEDULED_BACKUP",
              "jobStatus": "FAILED"
            }
          }
        ],
        "resource": {
          "type": "backupdr.googleapis.com/BackupDRProject"
        },
        "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
      }

    Ganti kode berikut:

    • PROJECT_ID: nama project.

  3. Salin entri log yang Anda konfigurasi sebelumnya.

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

    1. Di kolom Isi permintaan, ganti konten dengan entri log yang Anda salin pada langkah sebelumnya.
    2. Klik Jalankan. Jika diminta, ikuti alur autentikasi.

  5. Jika panggilan logEntries.write berhasil, Anda akan mendapatkan kode respons HTTP 200 dan isi respons kosong, {}. Untuk mengetahui informasi selengkapnya tentang APIs Explorer, lihat Menggunakan APIs Explorer.

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

    • Nilai logName menentukan log tugas pencadangan atau pemulihan di project cloud Anda.
    • jsonPayload berisi kategori tugas yang gagal, SCHEDULED_BACKUP, yang menunjukkan bahwa log terkait dengan pencadangan yang dijadwalkan oleh rencana pencadangan.
    • jsonPayload berisi status tugas kolom sebagai FAILED, yang menandakan bahwa tugas gagal.

  6. Setelah Anda menulis entri log, urutan berikut akan terjadi:

    1. Entri log baru akan muncul di Logs Explorer dan memicu pemberitahuan.
    2. Insiden akan dibuka di halaman 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 halaman Cloud Monitoring. Untuk mengetahui informasi selengkapnya tentang insiden, termasuk cara mengonfirmasi dan menutupnya, lihat Mengelola insiden untuk pemberitahuan berbasis log.