Menginstrumentasikan aplikasi C# untuk Error Reporting

Kumpulan library Google.Cloud.Diagnostics memungkinkan Anda mengirim peristiwa error langsung dari aplikasi C# ke Error Reporting sehingga Anda dapat mendiagnosis dan memantau error runtime. Dengan melengkapi aplikasi Anda menggunakan library, Anda dapat melaporkan peristiwa error kustom dan merekam error meskipun bucket log Anda menggunakan kunci enkripsi yang dikelola pelanggan (CMEK).

Untuk aplikasi yang berjalan di layanan Google Cloud terintegrasi, termasuk fungsi Cloud Run, App Engine, Compute Engine, dan Google Kubernetes Engine, Error Reporting juga dapat menyimpulkan peristiwa error secara otomatis dari Cloud Logging tanpa set library Google.Cloud.Diagnostics . Agar Pelaporan Error dapat menyimpulkan peristiwa error dari log, entri log Anda harus mengikuti persyaratan pemformatan error dan disimpan dalam bucket log non-CMEK yang dimiliki oleh project asal atau oleh project tujuan tempat log dirutekan.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Menginstal library klien

Kumpulan library Google.Cloud.Diagnostics memungkinkan Anda memantau dan melihat peristiwa error yang dilaporkan oleh aplikasi C# yang berjalan di hampir semua tempat.

1. Untuk aplikasi yang menargetkan ASP.NET Core 3 atau yang lebih baru, gunakan library Google.Cloud.Diagnostics.AspNetCore3. Anda dapat menginstal library ini dari NuGet.
2. Untuk aplikasi yang menargetkan ASP.NET Core versi yang lebih lama, gunakan library Google.Cloud.Diagnostics.AspNetCore. Anda dapat menginstal library ini dari NuGet.
3. Untuk aplikasi yang menargetkan framework non-ASP.NET Core, gunakan library Google.Cloud.Diagnostics.Common. Anda dapat menginstal library ini dari NuGet.

Untuk mengetahui informasi selengkapnya tentang penginstalan, baca dokumentasi untuk serangkaian library Google.Cloud.Diagnostics. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Untuk mengetahui informasi dan contoh selengkapnya, lihat referensi berikut:

Google.Cloud.Diagnostics.AspNetCore3 dokumentasi

Google.Cloud.Diagnostics.AspNetCore dokumentasi

Google.Cloud.Diagnostics.Common dokumentasi

Menjalankan aplikasi di Google Cloud

Untuk membuat grup error menggunakan projects.events.report, akun layanan Anda memerlukan peran Error Reporting Writer (roles/errorreporting.writer).

Beberapa Google Cloud layanan otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) kepada akun layanan yang sesuai. Namun, Anda harus memberikan peran ini ke akun layanan yang sesuai untuk beberapa layanan.

Cloud Run dan Cloud Run Functions

Akun layanan default yang digunakan oleh Cloud Run memiliki izin peran Error Reporting Writer (roles/errorreporting.writer).

Kumpulan library Google.Cloud.Diagnostics dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Cloud Run dikonfigurasi untuk menggunakan Error Reporting secara otomatis. Pengecualian JavaScript yang tidak tertangani akan muncul di Logging dan diproses oleh Error Reporting tanpa perlu menggunakan kumpulan library Google.Cloud.Diagnostics .

Catatan: Pelaporan Error otomatis membuat peristiwa error saat entri log berisi stack trace dan tingkat keparahan entri log tidak ditetapkan atau ditetapkan ke minimal ERROR.

Lingkungan fleksibel App Engine

App Engine memberikan peran Penulis Error Reporting (roles/errorreporting.writer) ke akun layanan default Anda secara otomatis.

Kumpulan library Google.Cloud.Diagnostics dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Error Reporting diaktifkan secara otomatis untuk aplikasi lingkungan fleksibel App Engine. Tidak diperlukan penyiapan tambahan. Pesan yang ditulis dari App Engine ke stderr dianalisis dan, jika ditemukan berisi stack trace, akan ditampilkan oleh Error Reporting.

Lihat Melihat error untuk mengetahui petunjuk tentang melihat data error dan pengecualian untuk aplikasi Anda di konsolGoogle Cloud .

Google Kubernetes Engine

Untuk menggunakan Error Reporting dengan Google Kubernetes Engine, lakukan langkah-langkah berikut:

1. Pastikan akun layanan yang akan digunakan oleh penampung Anda telah diberi peran Error Reporting Writer (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Buat cluster Anda dan berikan cloud-platform cakupan akses ke cluster.

   Misalnya, perintah create berikut menentukan cakupan akses cloud-platform dan akun layanan:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Catatan: Setelah membuat cluster, Anda tidak dapat mengubah akun layanannya.

Compute Engine

Untuk menggunakan Error Reporting dengan instance VM Compute Engine, lakukan langkah-langkah berikut:

1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberi peran Error Reporting Writer (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Di konsol Google Cloud , buka halaman VM instances.

   Buka instance VM

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

3. Pilih instance VM yang ingin Anda beri cloud-platform cakupan akses.

4. Klik Stop, lalu klik Edit.

5. Di bagian Identity and API access, pilih akun layanan yang memiliki peran Error Reporting Writer (roles/errorreporting.writer).

6. Di bagian Access scopes, pilih Allow full access to all Cloud APIs, lalu simpan perubahan Anda.

7. Klik Start/Resume.

Contoh

Untuk mengetahui informasi dan contoh selengkapnya, lihat referensi berikut:

Google.Cloud.Diagnostics.AspNetCore3 dokumentasi

Google.Cloud.Diagnostics.AspNetCore dokumentasi

Google.Cloud.Diagnostics.Common dokumentasi

Menjalankan aplikasi di lingkungan pengembangan lokal

Untuk menggunakan serangkaian library Google.Cloud.Diagnostics di lingkungan pengembangan lokal, seperti menjalankan library di workstation Anda sendiri, Anda harus memberikan serangkaian library Google.Cloud.Diagnostics dengan kredensial default aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi ke Error Reporting.

Untuk menggunakan contoh .NET di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

1. Instal Google Cloud CLI.

2. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda:

   gcloud auth application-default login

   Anda tidak perlu melakukan langkah ini jika menggunakan Cloud Shell.

   Catatan: Jika gcloud CLI menampilkan peringatan bahwa akun Anda tidak memiliki izin serviceusage.services.use, beberapa perintah gcloud CLI dan library klien mungkin tidak berfungsi. Minta administrator untuk memberi Anda peran IAM Service Usage Consumer (roles/serviceusage.serviceUsageConsumer), lalu jalankan perintah berikut:

   gcloud auth application-default set-quota-project PROJECT_ID

   Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, konfirmasi bahwa Anda telah login ke gcloud CLI dengan identitas gabungan Anda.

Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

Metode projects.events.report juga mendukung kunci API. Jika ingin menggunakan kunci API untuk autentikasi, Anda tidak perlu menyiapkan file Kredensial Default Aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Membuat kunci API di dokumentasi autentikasi Google Cloud .

Melihat grup error

Di konsol Google Cloud , buka halaman Error Reporting:

Buka Error Reporting

Anda juga dapat menemukan halaman ini dengan menggunakan kotak penelusuran.

Untuk mengetahui informasi selengkapnya, lihat Melihat dan memfilter grup error.