Menginstrumentasikan aplikasi Python untuk Error Reporting

Anda dapat mengirim laporan error ke Error Reporting dari aplikasi Python menggunakan library Error Reporting untuk Python. Gunakan library Pelaporan Error untuk Python guna 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 di project yang sama dengan tempat entri log berasal.
  • Entri log dirutekan ke project, lalu project tersebut menyimpan entri log tersebut di bucket log yang dimilikinya.
• Anda ingin melaporkan peristiwa error kustom.

Pelaporan Error terintegrasi dengan beberapa layanan Google Cloud, seperti Cloud Functions dan App Engine, Compute Engine, dan Google Kubernetes Engine. Error Reporting menampilkan error yang dicatat ke dalam log 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 data error ke Error Reporting menggunakan Logging. Untuk informasi tentang persyaratan pemformatan data, baca Memformat pesan error di Logging.

Sebelum memulai

1. 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.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the API

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

   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

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

8. Siapkan lingkungan Anda untuk pengembangan Python.

   Buka panduan penyiapan Python

Menginstal library klien

Library Pelaporan Error untuk Python memungkinkan Anda memantau dan melihat error yang dilaporkan oleh aplikasi Python yang berjalan hampir di mana saja.

1. Buat instance lingkungan virtual dan gunakan pip untuk menginstal paket:

   pip install google-cloud-error-reporting --upgrade
   

2. Impor library dan buat instance klien untuk mulai melaporkan error:

   Python

   Untuk melakukan autentikasi ke Error Reporting, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

   #!/usr/bin/env python
   #
   # Copyright 2022 Google, Inc.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   
   
   def report_exception():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       try:
           raise Exception("Something went wrong")
       except Exception:
           client.report_exception()
   
   
   
   
   def report_manual_error():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       client.report("An error has occurred.")
   
   
   
   
   if __name__ == "__main__":
       report_exception()
       report_manual_error()
   

Untuk informasi selengkapnya tentang penginstalan, baca dokumentasi untuk library Pelaporan Error untuk Python. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Anda dapat menyesuaikan perilaku library Pelaporan Error untuk Python. Lihat dokumentasi library klien untuk mengetahui contoh konfigurasi.

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 layanan Google Cloud secara otomatis memberikan peran Penulis Pelaporan Error (roles/errorreporting.writer) ke 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 Penulis Pelaporan Error (roles/errorreporting.writer).

Library Pelaporan Error untuk Python 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 library Error Reporting untuk Python.

Catatan: Entri log diproses secara otomatis jika berisi pelacakan tumpukan dan tidak menentukan tingkat keparahan log atau tingkat keparahan log minimal ERROR, tanpa perlu menggunakan library Pelaporan Error untuk Python.

Lingkungan fleksibel App Engine

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

Library Pelaporan Error untuk Python dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Pelaporan Error diaktifkan secara otomatis untuk aplikasi lingkungan fleksibel App Engine. Tidak diperlukan penyiapan tambahan.

Catatan: Entri log error yang ditulis ke stderr diproses secara otomatis oleh Error Reporting, tanpa perlu menggunakan library Error Reporting untuk Python secara langsung.

Google Kubernetes Engine

Untuk menggunakan Pelaporan Error dengan Google Kubernetes Engine, lakukan tindakan berikut:

1. Pastikan akun layanan yang akan digunakan oleh penampung Anda telah diberikan 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 dan berikan cakupan akses cloud-platform 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 Pelaporan Error dengan instance VM Compute Engine, lakukan langkah berikut:

1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberikan 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 Instance VM:

   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 terima cakupan akses cloud-platform.

4. Klik Berhenti, 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 Mulai/Lanjutkan.

Contoh

Anda dapat melaporkan error secara manual dengan memanggil metode report, seperti yang terlihat dalam contoh berikut:

Python

Untuk melakukan autentikasi ke Error Reporting, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi.

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()




def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")




if __name__ == "__main__":
    report_exception()
    report_manual_error()

Menjalankan aplikasi di lingkungan pengembangan lokal

Untuk menggunakan library Pelaporan Error untuk Python di lingkungan pengembangan lokal, seperti menjalankan library di workstation Anda sendiri, Anda harus menyediakan library Pelaporan Error untuk Python dengan kredensial default aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi ke Error Reporting.

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

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. 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

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 informasi selengkapnya, lihat Membuat kunci API dalam dokumentasi autentikasi Google Cloud.

Melihat laporan error

Di konsol Google Cloud, buka halaman Pelaporan Error:

Buka Error Reporting

Anda juga dapat menemukan halaman ini menggunakan kotak penelusuran.

Untuk mengetahui informasi selengkapnya, lihat Melihat Error.