Mengonfigurasi dan mengelola notifikasi

Anda dapat mengonfigurasi Error Reporting untuk mengirim notifikasi ke saluran notifikasi Cloud Monitoring yang dipilih saat peristiwa error terjadi.

Error Reporting mengirim notifikasi dalam kasus berikut:

• Saat peristiwa error terjadi di sebuah Google Cloud project dan peristiwa tersebut tidak dapat di kelompokkan dengan error sebelumnya.

• Jika peristiwa error terjadi dalam grup error yang ditandai sebagai Diselesaikan.

Mengelola saluran notifikasi

Anda membuat, mengedit, dan menghapus saluran notifikasi di Monitoring. Setelah membuat saluran notifikasi, Anda dapat mengonfigurasi Error Reporting untuk menggunakannya.

Error Reporting memungkinkan Anda memilih dari empat jenis saluran notifikasi: email, seluler, Slack, dan Webhook.

Sebelum memulai

Untuk mendapatkan izin yang diperlukan untuk melihat dan mengonfigurasi saluran notifikasi menggunakan Google Cloud konsol, 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 ke project, folder, dan organisasi.

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.

Membuat saluran notifikasi

Untuk membuat saluran notifikasi menggunakan Google Cloud konsol, ikuti petunjuk khusus saluran yang terdapat dalam tabel berikut:

Email

Untuk menambahkan saluran notifikasi email, lakukan hal berikut:

1. Di Google Cloud konsol, buka halaman  Alerting:

   Buka Pemberitahuan

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

2. Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan.
3. Klik Edit notification channels.
4. Di bagian Email, klik Add new.
5. Masukkan satu alamat email dan deskripsi.
6. Klik Save.

Jika Anda menggunakan alamat email grup sebagai saluran notifikasi untuk kebijakan pemberitahuan, konfigurasi grup agar menerima email dari [e-mail].

Aplikasi Seluler

Gunakan Google Cloud Aplikasi Seluler konsol untuk memantau Google Cloud resource konsol dan Monitoring informasi Anda dari mana saja. Google Cloud Notifikasi Aplikasi Seluler konsol dikirim ke perangkat tertentu atau ke pengguna tertentu:

• Perangkat menunjukkan bahwa notifikasi hanya dikirim ke perangkat tertentu yang membuat saluran notifikasi. Untuk saluran notifikasi dengan cakupan perangkat, kolom Display name menyertakan informasi perangkat.
• Pengguna menunjukkan bahwa notifikasi dikirim ke semua perangkat Anda yang menginstal Aplikasi Seluler Google Cloud konsol.

Cloud Monitoring menentukan cakupan notifikasi saat saluran dibuat. Anda tidak dapat memilih atau mengubah cakupan.

Untuk mengonfigurasi saluran notifikasi Aplikasi Seluler konsol untuk project tertentu, lakukan hal berikut: Google Cloud Google Cloud

1. Instal Aplikasi Seluler Google Cloud konsol dari app store perangkat seluler Anda.

2. Pilih project untuk dilihat di Aplikasi Seluler Google Cloud konsol.

   Setelah Anda memilih project, pertukaran data antara aplikasi dan project yang dipilih Google Cloud akan terjadi. Saluran notifikasi dibuat jika tidak ada, dan setelah beberapa menit, saluran ini akan tercantum di bagian Mobile Devices pada halaman Notification channels.

Untuk menambahkan perangkat seluler Anda sebagai saluran notifikasi untuk kebijakan pemberitahuan , di bagian Notifications pemberitahuan, pilih Google Cloud console (mobile) , lalu pilih perangkat seluler Anda dari daftar.

Slack

Catatan: Untuk menyelesaikan langkah-langkah ini, Anda harus menjadi Pemilik atau Admin Ruang Kerja Slack. Untuk mengetahui informasi selengkapnya, lihat Mengelola permintaan undangan.

Untuk menyiapkan notifikasi Slack, lakukan hal berikut:

1. Di Slack: Buat ruang kerja dan saluran Slack di situs Slack. Catat URL saluran.

2. Di Google Cloud konsol, buka halaman  Alerting:

   Buka Pemberitahuan

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

3. Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan.

4. Klik Edit notification channels.

5. Di bagian Slack, klik Add new untuk membuka halaman login Slack:

   1. Pilih ruang kerja Slack Anda.
   2. Klik Allow untuk mengaktifkan akses Cloud Monitoring ke ruang kerja Slack Anda. Tindakan ini akan membawa Anda kembali ke halaman konfigurasi Monitoring untuk saluran notifikasi Anda.
   3. Di kolom Slack Channel Name, masukkan nama saluran Slack yang ingin Anda gunakan untuk notifikasi.
   4. Di kolom Cloud Alerting Display Name, masukkan pernyataan deskriptif singkat. Monitoring menampilkan nilai kolom ini di halaman Notifications channel.
   5. (Opsional) Untuk menguji koneksi antara Cloud Monitoring dan ruang kerja Slack Anda, klik Send test notification. Jika koneksi berhasil, maka Anda akan melihat pesan This is a test alert notification... di saluran notifikasi Slack yang Anda tentukan. Periksa saluran notifikasi untuk mengonfirmasi penerimaan.

6. Jika saluran Slack yang ingin Anda gunakan untuk notifikasi adalah saluran pribadi, Anda harus mengundang aplikasi Monitoring ke saluran tersebut secara manual:

   1. Buka Slack.

   2. Buka saluran yang Anda tentukan sebagai saluran notifikasi Monitoring.

   3. Undang aplikasi Monitoring ke saluran dengan memasukkan dan mengirim pesan berikut di saluran:

      /invite @Google Cloud Monitoring

      Pastikan Anda mengundang aplikasi Monitoring ke saluran pribadi yang Anda tentukan saat membuat saluran notifikasi di Monitoring. Mengundang aplikasi Monitoring ke saluran publik bersifat opsional.

Webhook

Sebelum mengonfigurasi saluran notifikasi Webhook, pertimbangkan hal berikut:

• Webhook hanya mendukung endpoint publik. Endpoint publik dapat diakses sepenuhnya dari internet publik, seperti melalui HTTP (port:80) atau HTTPS (port:443). Layanan notifikasi harus dapat membuat koneksi ke endpoint dan, dalam kasus HTTPS, memverifikasi sertifikat keamanan server.
• Jika fungsi Cloud Run dikonfigurasi sebagai endpoint webhook untuk saluran notifikasi, pastikan pengguna yang memanggil fungsi tersebut memiliki izin autentikasi yang diperlukan. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi pemanggilan dan Mengaktifkan akses ke fungsi.
• Untuk mengirim data notifikasi dari Monitoring ke Microsoft Teams, Anda harus menggunakan layanan perantara seperti Power Automate atau fungsi Cloud Run. Konfigurasi layanan untuk menerima notifikasi webhook Monitoring mengonversi data ke format yang kompatibel dengan Teams, dan meneruskan data ke saluran Microsoft Teams yang sesuai.

Mengonfigurasi saluran notifikasi Webhook

Untuk mengonfigurasi notifikasi Webhook, lakukan hal berikut:

1. Penangan webhook: Identifikasi URL endpoint publik untuk menerima data webhook dari Monitoring.

2. Di Google Cloud konsol, buka halaman  Alerting:

   Buka Pemberitahuan

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

3. Di toolbar konsol Google Cloud , pilih Google Cloud project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan.
4. Klik Edit notification channels.
5. Di bagian Webhook, klik Add new.
6. Lengkapi dialog.
7. Klik Test Connection untuk mengirim payload pengujian ke endpoint Webhook endpoint. Anda dapat membuka endpoint penerima untuk memverifikasi pengiriman.
8. Klik Save.

Skema Webhook

Untuk melihat struktur skema Webhook untuk Error Reporting, klik berikut:

Struktur skema, versi 1.0

{
  "version": "1.0",
  "subject": string, description of the new or reopened error group.
  "group_info": {
    "project_id": string, project that owns the error group.
    "detail_link": string, link to the Error Reporting Details page for the error group.
  },
  "exception_info": {
    "type": string, type of the exception logged in the event.
    "message": string, exception message for the event.
  },
  "event_info": {
    "log_message": string
    "request_method": string
    "request_url": string
    "referrer": string
    "user_agent": string
    "service": string
    "version": string
    "response_status": string
  },
}

Autentikasi dasar

Selain permintaan webhook yang dikirim oleh Cloud Monitoring, autentikasi dasar menggunakan spesifikasi HTTP untuk nama pengguna dan sandi. Cloud Monitoring mengharuskan server Anda menampilkan respons 401 dengan header WWW-Authenticate yang tepat. Untuk mengetahui informasi selengkapnya tentang autentikasi dasar, lihat hal berikut:

• Spesifikasi RFC
• Autentikasi dasar

Autentikasi token

Autentikasi Token memerlukan parameter string kueri di URL endpoint dan kunci yang diharapkan server bersifat rahasia antara server dan Monitoring. Berikut adalah contoh URL yang menyertakan token:

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Jika Monitoring memposting insiden ke URL endpoint, server Anda dapat memvalidasi token terlampir. Metode autentikasi ini paling efektif jika digunakan dengan SSL/TLS untuk mengenkripsi permintaan HTTP sehingga mencegah pengintai mempelajari token.

Untuk contoh server di Python, lihat ini contoh server.

Mengedit dan menghapus saluran notifikasi

Untuk mengedit atau menghapus saluran notifikasi menggunakan Google Cloud konsol, lakukan hal berikut:

1. Di Google Cloud konsol, buka halaman  Alerting:

   Buka Pemberitahuan

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

2. Klik Edit notification channels.

   Dasbor Notification channels berisi bagian untuk setiap jenis saluran notifikasi. Setiap bagian mencantumkan semua konfigurasi untuk jenis tersebut:

   • Untuk mengubah entri, klik Edit. Klik Save setelah perubahan selesai.
   • Untuk menghapus entri, klik Delete. Klik Delete di dialog konfirmasi.

Catatan: Anda tidak dapat menghapus saluran notifikasi menggunakan Google Cloud konsol jika saluran tersebut terkait dengan kebijakan pemberitahuan. Namun, Anda dapat menghapus saluran menggunakan Google Cloud CLI atau Cloud Monitoring API. Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola saluran notifikasi melalui API.

Memilih saluran notifikasi melalui Google Cloud konsol

Untuk memilih saluran notifikasi yang ada, Anda harus memiliki salah satu peran berikut:

• Error Reporting User
• Error Reporting Admin
• Project Editor
• Project Owner

Untuk memilih tempat Anda ingin mengirim notifikasi saat grup error baru terjadi, selesaikan langkah-langkah berikut.

1. Di Google Cloud konsol, buka halaman Error Reporting:

   Buka Error Reporting

   Anda juga dapat menemukan halaman ini menggunakan kotak penelusuran.

2. Klik Configure notifications untuk membuka halaman Error notifications.

3. Di menu drop-down Notification channels, pilih saluran yang ingin Anda kirimi notifikasi.

   Jika Anda tidak melihat saluran yang diperlukan, klik Manage notification channels untuk membuat saluran baru. Untuk membuat saluran notifikasi, peran Anda harus salah satu yang tercantum di Membuat saluran.

4. Setelah memilih saluran, klik Save.

Informasi tambahan

Berikut adalah informasi tambahan yang berlaku saat membuat dan mengelola notifikasi di Error Reporting.

Konten notifikasi

Notifikasi untuk grup error berisi informasi terkait entri log dalam grup. Informasi yang disertakan bergantung pada jenis resource yang dipantau tempat peristiwa error terjadi. Misalnya, beberapa notifikasi mungkin berisi nama dan versi resource yang dipantau.

Pesan yang menjelaskan peristiwa error disertakan dalam notifikasi hanya jika grup error diidentifikasi oleh entri log dalam bucket log yang wilayahnya adalah global.

Kapan notifikasi dikirim

Error Reporting mengirim notifikasi dalam dua skenario:

• Saat peristiwa error terjadi dan tidak ada grup error yang ada.
• Saat peristiwa error terjadi untuk grup error yang ada dan status grup error ditetapkan ke Resolved.

Untuk menerima notifikasi mendatang untuk grup error, Anda harus menetapkan status grup error ke Resolved. Tidak ada tindakan lain, seperti menggunakan API untuk menghapus grup error atau menunggu data menjadi tidak berlaku, yang akan menghasilkan notifikasi jika peristiwa error lain terjadi.

Batas frekuensi notifikasi

Error Reporting menggunakan aturan berikut untuk membatasi jumlah notifikasi yang mungkin Anda terima karena peristiwa error:

• Maksimal 5 notifikasi per grup error dapat dikirim dalam jangka waktu 60 menit.

• Jika lebih dari 5 peristiwa error dalam grup error yang sama terjadi dalam jangka waktu 60 menit, hal berikut akan terjadi:

  • Anda akan menerima notifikasi bahwa notifikasi lebih lanjut akan dinonaktifkan selama enam jam berikutnya.

  • Entri log dengan tingkat keparahan peringatan akan ditulis.

• Saat Anda menyelesaikan grup error, notifikasi untuk grup error tersebut akan ditangguhkan selama lima menit.

Status penyelesaian

Jika peristiwa error terjadi dalam grup error yang memiliki status penyelesaian Diselesaikan, meskipun peristiwa error sebelumnya telah dihapus, status grup error akan ditetapkan ke Terbuka dan Error Reporting akan mengirim notifikasi.

Namun, Error Reporting tidak mengirim notifikasi saat peristiwa error terjadi dan grup error yang sesuai adalah Muted.

Untuk mengelola status penyelesaian grup error, buka Mengelola grup error.

Notifikasi seluler

Error Reporting mengirim notifikasi seluler ke Google Cloud aplikasi di Android dan iOS. Untuk mengaktifkan notifikasi seluler, Anda harus menginstal aplikasi di perangkat seluler terlebih dahulu:

Downloadaplikasi Google Cloud