Melengkapi aplikasi Python untuk Error Reporting

Anda dapat mengirim laporan error ke Error Reporting dari aplikasi Python dengan menggunakan library Error Reporting untuk Python. Gunakan library Error Reporting untuk Python guna membuat grup error untuk kasus berikut:

  • Bucket log Anda memiliki kunci enkripsi yang dikelola pelanggan (CMEK).
  • Bucket log Anda tidak berada di region global.
  • Anda ingin melaporkan peristiwa error kustom.

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

Anda juga dapat mengirim data error ke Error Reporting menggunakan Logging. Untuk mengetahui informasi tentang persyaratan pemformatan data, baca Memformat pesan error di Logging.

Sebelum memulai

  1. 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.
  2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  4. Aktifkan Error Reporting API .

    Mengaktifkan API

  5. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  6. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  7. Aktifkan Error Reporting API .

    Mengaktifkan API

  8. Siapkan lingkungan Anda untuk pengembangan Python.

    Buka panduan penyiapan Python

Menginstal library klien

Library Error Reporting 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, baca 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 mengetahui informasi selengkapnya tentang penginstalan, baca dokumentasi untuk library Error Reporting untuk Python. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Anda dapat menyesuaikan perilaku library Error Reporting 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 Penulis Error Reporting (roles/errorreporting.writer).

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

Lingkungan fleksibel App Engine

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

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

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

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 Penulis Pelaporan Error (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 beri cluster cakupan akses cloud-platform.

    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
    

Compute Engine

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

  1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberi peran Penulis Error Reporting (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 panel navigasi Konsol Google Cloud, pilih Compute Engine, lalu pilih VM instances:

    Buka instance VM

  3. Pilih instance VM yang Anda inginkan untuk menerima cakupan akses cloud-platform.

  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 scope, pilih Allow full access to all Cloud APIs, lalu simpan perubahan.

  7. Klik Mulai/Lanjutkan.

Contoh

Anda dapat melaporkan error secara manual dengan memanggil metode report, seperti yang terlihat pada 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

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

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

  1. Menginstal Google Cloud CLI.
  2. Untuk initialize gcloud CLI, jalankan perintah berikut:

    gcloud init
  3. Buat kredensial autentikasi lokal untuk Akun Google Anda:

    gcloud auth application-default login

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

Melihat laporan error

Di panel navigasi konsol Google Cloud, pilih Error Reporting, lalu pilih project Google Cloud Anda:

Buka Error Reporting

Untuk informasi selengkapnya, lihat Melihat Error.