Menginstrumentasikan aplikasi Ruby untuk Error Reporting

Anda dapat mengirim laporan error ke Error Reporting dari aplikasi Ruby menggunakan library Error Reporting untuk Ruby. Gunakan library Error Reporting untuk Ruby 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 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 layanan, seperti Cloud Functions dan App Engine, Compute Engine, dan Google Kubernetes Engine. Google Cloud Error Reporting menampilkan 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 data error ke Error Reporting menggunakan Logging. Untuk mengetahui 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.

    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.

    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.
  8. Instal Ruby 2.2+ atau yang lebih baru.

    9. Menginstal library klien

    Library Error Reporting untuk Ruby memungkinkan Anda memantau dan melihat error yang dilaporkan oleh aplikasi Ruby yang berjalan di hampir semua tempat.

    1. Tambahkan gem google-cloud-error_reporting ke Gemfile Anda:

      gem "google-cloud-error_reporting"

    2. Gunakan Bundler untuk menginstal gem:

      bundle install

    Mengaktifkan library

    Jika Anda menggunakan Ruby on Rails, Bundler akan otomatis memuat library ke dalam aplikasi Anda saat dimulai.

    Aplikasi berbasis Rack lainnya dapat menggunakan Middleware Rack yang disediakan oleh pustaka:

    require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

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

    Mengonfigurasi library klien

    Anda dapat menyesuaikan perilaku library Error Reporting untuk Ruby. Lihat konfigurasi library untuk mengetahui daftar kemungkinan opsi 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 secara otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) ke akun layanan yang sesuai. Google Cloud 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).

    Library Error Reporting untuk Ruby 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 Ruby.

    Menggunakan antarmuka konfigurasi Ruby on Rails

    Untuk menggunakan library Error Reporting untuk Ruby dengan framework Ruby on Rails, berikan parameter melalui antarmuka konfigurasi Ruby on Rails:

    # Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

    Anda juga dapat menyetel konfigurasi bersama untuk semua gem Stackdriver menggunakan berikut:

    # Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

    Pelaporan Error diaktifkan secara default saat Rails berjalan dalam mode produksi. Untuk mengaktifkan Error Reporting dalam mode pengembangan, tambahkan kode berikut:

    # Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

    Menggunakan antarmuka konfigurasi instrumentasi

    Untuk menggunakan library Error Reporting untuk Ruby di aplikasi berbasis Rack lainnya, berikan parameter melalui antarmuka konfigurasi:

    require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

    Anda juga dapat menyetel konfigurasi bersama untuk semua gem Google Cloud Observability menggunakan perintah berikut:

    require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

    Lingkungan fleksibel App Engine

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

    Library Error Reporting untuk Ruby 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 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 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

    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 Mulai/Lanjutkan.

    Contoh

    Melaporkan error di framework berbasis Rack

    Library Error Reporting untuk Ruby memudahkan integrasi Error Reporting ke dalam framework web Ruby berbasis Rack yang populer seperti Ruby on Rails dan Sinatra. Jika diaktifkan, library akan otomatis melaporkan pengecualian yang diambil dari stack Rack aplikasi.

    Melaporkan error secara manual

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

    require "google/cloud/error_reporting"

begin
  raise "Something went wrong"
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

    Menjalankan aplikasi di lingkungan pengembangan lokal

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

    Untuk menggunakan contoh Ruby 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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

      gcloud init

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

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

    Menggunakan antarmuka konfigurasi Ruby on Rails

    Untuk menggunakan library Error Reporting untuk Ruby dengan framework Ruby on Rails, berikan parameter melalui antarmuka konfigurasi Ruby on Rails:

    # Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

    Anda juga dapat menyetel konfigurasi bersama untuk semua gem Stackdriver menggunakan berikut:

    # Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

    Pelaporan Error diaktifkan secara default saat Rails berjalan dalam mode produksi. Untuk mengaktifkan Error Reporting dalam mode pengembangan, tambahkan kode berikut:

    # Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

    Menggunakan antarmuka konfigurasi instrumentasi

    Untuk menggunakan library Error Reporting untuk Ruby di aplikasi berbasis Rack lainnya, berikan parameter melalui antarmuka konfigurasi:

    require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

    Anda juga dapat menyetel konfigurasi bersama untuk semua gem Google Cloud Observability menggunakan perintah berikut:

    require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

    Melihat laporan 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 Error.