Mengumpulkan data error menggunakan Error Reporting

Dokumen ini mencantumkan lingkungan yang didukung oleh Pelaporan Error dan memiliki link ke panduan khusus bahasa untuk developer aplikasi. Sebaiknya gunakan library klien khusus bahasa atau andalkan entri log yang dikumpulkan secara otomatis. Namun, Anda dapat menulis data error dengan Cloud Logging API atau Error Reporting API. Misalnya, jika Anda menggunakan Cloud Run, pengecualian yang ditulis ke stderr akan otomatis dikirim ke Cloud Logging.

Error Reporting adalah layanan global yang dibuat di Cloud Logging dan dapat menganalisis entri log jika semua hal berikut terpenuhi:

  • 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. 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 dalam bucket log yang dimilikinya.
Jika menyimpan entri log di bucket log dengan CMEK diaktifkan, Anda masih dapat menggunakan Pelaporan Error. Namun, Anda harus menggunakan library klien Error Reporting atau Error Reporting API. Untuk informasi selengkapnya, lihat ringkasan Error Reporting API dan library klien Error Reporting.

Dukungan Virtual Private Cloud

Pelaporan Error adalah layanan yang didukung Virtual Private Cloud (VPC).

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

Mengonfigurasi lingkungan untuk melaporkan data error secara otomatis

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

Melengkapi aplikasi dengan menggunakan library klien

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

Menulis data error menggunakan API

Anda dapat melaporkan peristiwa error ke project Google Cloud dengan menjalankan metode Error Reporting API report atau metode Cloud 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 Cloud 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 Cloud Logging. Untuk mengontrol entri log yang diserap, lihat Filter pengecualian.

    Jika Anda melaporkan peristiwa error menggunakan Error Reporting API, bagian lain dalam dokumen ini tidak berlaku.

  • Jika ingin menggunakan Cloud Logging API, Anda harus memformat objek LogEntry agar menyertakan pelacakan tumpukan, atau objek ReportedErrorEvent. Untuk informasi selengkapnya tentang persyaratan pemformatan, lihat Error format dalam log.