Error Reporting API menyediakan:
- Endpoint sederhana untuk melaporkan error dari layanan yang sedang berjalan.
- Akses baca ke kelompok error dan error-nya yang terkait.
Memulai
Aktifkan Error Reporting API.
Peran yang diperlukan untuk mengaktifkan API
Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin
(roles/serviceusage.serviceUsageAdmin),
yang berisi izin serviceusage.services.enable. Pelajari cara memberikan
peran.
Memberi otorisasi penggunaan API
Akses ke Error Reporting API dikontrol oleh peran dan izin Identity and Access Management. Anda dapat mengetahui lebih lanjut autentikasi dan otorisasi untuk Google Cloud API di Panduan autentikasi.
Model data
Error Reporting API menentukan tiga entitas: peristiwa error, grup error, dan statistik grup error. Objek statistik grup error adalah objek yang paling sering digunakan oleh sebagian besar pengguna.
Peristiwa error
ErrorEvent mewakili satu kejadian error di aplikasi Anda. Objek berisi informasi tentang error, seperti waktu terjadinya, konteks terjadinya, dan pesan error yang ditampilkan. Peristiwa error dijamin tersedia setidaknya selama 30 hari setelah dibuat.
Grup error
Objek ErrorGroup adalah kumpulan peristiwa error yang dikelompokkan secara logis. Pengelompokan didasarkan pada informasi dalam pelacakan tumpukan peristiwa error. Grup error adalah objek sederhana yang hanya berisi nama, ID grup, dan masalah pelacakan terkait untuk grup.
Untuk memperbarui URL masalah pelacakan, gunakan metode update resource ini.
Error statistik grup
Objek ErrorGroupStats berisi informasi mendetail tentang grup error, dan merupakan objek API yang paling sering Anda gunakan. Informasi dalam objek groupStats mencakup waktu pertama dan terakhir kali peristiwa error dalam grup ini terjadi, jumlah, jumlah pengguna yang terpengaruh, dan lainnya. Objek ini berguna saat membuat widget dan dasbor kustom.
Operasi
Error Reporting API mendukung operasi berikut:
- Melaporkan peristiwa error baru
- Mencantumkan statistik grup error
- Membuat daftar peristiwa error
- Mendapatkan grup error
- Memperbarui masalah pelacakan grup error
Melaporkan peristiwa error
Anda dapat melaporkan peristiwa error dari layanan yang sedang berjalan dengan menuliskannya ke ReportedErrorEvent. Tindakan ini akan menghasilkan pesan error yang diformat dengan benar di Cloud Logging. Nama log yang dihasilkan diformat sebagai projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors. Anda mungkin dikenai sedikit biaya penyerapan Cloud Logging menggunakan metode ini; untuk mengontrol biaya ini, tinjau Pengecualian log.
Anda juga dapat melaporkan peristiwa error baru ke Error Reporting dengan menyusun entitas peristiwa error dari layanan yang sedang berjalan dan mengirimkannya ke metode events.report.
Mencantumkan statistik grup error
Untuk mendapatkan daftar statistik grup error, kirim permintaan ke metode groupStats.list. Anda dapat meneruskan satu atau beberapa parameter kueri untuk memfilter statistik grup yang ditampilkan.
Membuat daftar peristiwa error
Untuk mendapatkan daftar peristiwa error yang termasuk dalam grup error tertentu, kirim permintaan ke metode events.list. Anda dapat meneruskan kondisi filter ke permintaan ini untuk mengambil hanya peristiwa error yang terjadi antara waktu mulai dan berakhir tertentu, atau yang cocok dengan konteks layanan tertentu.
Mendapatkan grup error
Untuk mengambil resource grup error tertentu, kirim permintaan ke metode groups.get.
Memperbarui grup error
Untuk memperbarui URL masalah pelacakan yang terkait dengan grup error, kirim resource ErrorGroup yang telah diperbarui ke metode groups.update.