Menginstrumentasikan aplikasi C# untuk Error Reporting

Anda dapat mengirim peristiwa error ke Error Reporting dari aplikasi C# menggunakan kumpulan library Google.Cloud.Diagnostics . Gunakan serangkaian library Google.Cloud.Diagnostics untuk membuat grup error untuk kasus berikut:

• Bucket log yang berisi entri log Anda memiliki kunci enkripsi yang dikelola pelanggan (CMEK).
• Bucket log memenuhi salah satu hal berikut:
  • Bucket log disimpan dalam project yang sama dengan tempat asal entri log.
  • Entri log dirutekan ke project, lalu project tersebut menyimpan entri log tersebut dalam bucket log miliknya.
• Anda ingin melaporkan peristiwa error kustom.

Pelaporan Error terintegrasi dengan beberapa Google Cloud layanan, seperti fungsi Cloud Run dan App Engine, Compute Engine, dan Google Kubernetes Engine. Error Reporting menampilkan peristiwa error yang dicatat ke Cloud Logging oleh aplikasi yang berjalan di layanan tersebut. Untuk mengetahui informasi selengkapnya, buka Berjalan di Google Cloud di halaman ini.

Anda juga dapat mengirim peristiwa error ke Error Reporting menggunakan Logging. Untuk mengetahui informasi tentang persyaratan pemformatan data, baca artikel Memformat entri log untuk melaporkan peristiwa error.

Sebelum memulai

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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 .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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 .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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 sebelumnya, 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 kumpulan library Google.Cloud.Diagnostics . Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Untuk mengetahui informasi dan contoh selengkapnya, lihat referensi berikut:

1. Google.Cloud.Diagnostics.AspNetCore3 dokumentasi
2. Google.Cloud.Diagnostics.AspNetCore dokumentasi
3. 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 ditangani akan muncul di Logging dan diproses oleh Error Reporting tanpa perlu menggunakan serangkaian 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 Error Reporting Writer (roles/errorreporting.writer) ke akun layanan default Anda secara otomatis.

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

Pelaporan Error 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 hal 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 cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

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

   Misalnya, perintah pembuatan 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 cara memberikan 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 Hentikan, 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:

4. Google.Cloud.Diagnostics.AspNetCore3 dokumentasi
5. Google.Cloud.Diagnostics.AspNetCore dokumentasi
6. Google.Cloud.Diagnostics.Common dokumentasi

Menjalankan aplikasi di lingkungan pengembangan lokal

Untuk menggunakan kumpulan library Google.Cloud.Diagnostics di lingkungan pengembangan lokal, seperti menjalankan library di workstation Anda sendiri, Anda harus memberikan kumpulan 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.

Instal Google Cloud CLI.

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

If you're using a local shell, then create local authentication credentials for your user account:

gcloud auth application-default login

You don't need to do this if you're using Cloud Shell.

Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

gcloud auth application-default set-quota-project PROJECT_ID

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Untuk informasi selengkapnya, lihat Set up authentication for a local development environment.

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.