Mengumpulkan data error menggunakan Error Reporting

Anda dapat mengirim peristiwa error dan pengecualian aplikasi ke Error Reporting agar Error Reporting dapat menganalisis data error di projectGoogle Cloud Anda. Bergantung pada lingkungan komputasi, bahasa pemrograman, dan persyaratan autentikasi, Anda dapat mengumpulkan data error dengan cara berikut:

  • Pengumpulan log otomatis: Lingkungan komputasi yang didukung secara otomatis mengirim data error ke Cloud Logging agar dianalisis oleh Error Reporting. Misalnya, Cloud Run secara otomatis mengirimkan pengecualian yang ditulis ke stderr ke Logging.
  • Library klien: Anda dapat menginstrumentasikan kode aplikasi dengan library klien khusus bahasa untuk mengirim laporan error langsung dari aplikasi Anda.
  • REST API: Anda dapat memanggil Error Reporting API atau Cloud Logging API untuk menulis peristiwa error dan stack trace yang diformat, termasuk saat Anda memerlukan autentikasi kunci API.

Saat Error Reporting menganalisis entri log

Error Reporting adalah layanan global yang dibangun di atas Cloud Logging dan dapat menganalisis entri log jika semua hal berikut benar:

  • Assured Workloads dinonaktifkan. Untuk mengetahui informasi selengkapnya, lihat Ringkasan Assured Workloads.
  • Kunci enkripsi yang dikelola pelanggan (CMEK) dinonaktifkan di semua bucket log yang menyimpan entri log. Error Reporting tidak dapat menyimpan entri log di bucket log yang mengaktifkan CMEK. Untuk mengetahui informasi tentang cara menentukan konfigurasi CMEK untuk bucket log, lihat Memverifikasi pengaktifan kunci.
  • Bucket log memenuhi salah satu hal berikut:
    • Bucket log disimpan di project yang sama dengan tempat entri log berasal.
    • Entri log dirutekan ke project, lalu project tersebut menyimpan entri log tersebut di bucket log miliknya.

Dukungan Kontrol Layanan VPC

Kontrol Layanan VPC mendukung Error Reporting.

Untuk mengurangi risiko pemindahan data yang tidak sah, gunakan Kontrol Layanan VPC untuk membuat perimeter layanan di sekitar layanan yang dikelola Google. Untuk mengetahui informasi tentang Kontrol Layanan VPC dan cara membuat perimeter layanan, lihat dokumentasi Kontrol Layanan VPC.

Mengonfigurasi lingkungan untuk melaporkan data error secara otomatis

Untuk mengetahui informasi tentang persyaratan konfigurasi khusus lingkungan, lihat panduan berikut:

Melengkapi aplikasi dengan menggunakan library klien

Untuk mengetahui informasi tentang cara mengonfigurasi aplikasi Anda agar mengirim laporan error, lihat panduan konfigurasi khusus bahasa:

Menulis data error menggunakan API

Anda dapat melaporkan peristiwa error ke project Google Cloud dengan mengeksekusi metode Error Reporting API report atau metode Logging API write.

  • Jika memerlukan autentikasi berbasis kunci API, Anda harus menggunakan Error Reporting API. Untuk melaporkan peristiwa error menggunakan Error Reporting API, jalankan metode report dan format isi permintaan metode sebagai objek ReportedErrorEvent.

    Saat Anda menggunakan Error Reporting API, entri log dengan pesan error yang diformat dengan benar akan otomatis dibuat dan ditulis ke Logging. Entri log ini ditulis ke log yang logName-nya diformat sebagai berikut:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors

    Karena entri log dihasilkan oleh panggilan ke report, Anda mungkin dikenai biaya penyerapan Logging. Untuk mengontrol entri log yang akan diserap, lihat Filter pengecualian.

  • Jika ingin menggunakan Logging API, Anda harus memformat objek LogEntry sehingga menyertakan stack trace atau objek ReportedErrorEvent. Untuk mengetahui informasi selengkapnya tentang persyaratan pemformatan, lihat Error format dalam log.