Menginstrumentasikan aplikasi Ruby untuk Error Reporting

Library Error Reporting untuk Ruby memungkinkan Anda mengirim peristiwa error langsung dari aplikasi Ruby 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 terintegrasi Google Cloud —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 library Error Reporting untuk Ruby. 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

1. Instal Ruby 2.2+ atau yang lebih baru.

Menginstal library klien

Library Error Reporting untuk Ruby memungkinkan Anda memantau dan melihat peristiwa 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 opsi konfigurasi yang mungkin.

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

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 tertangani akan muncul di Logging dan diproses oleh Error Reporting tanpa perlu menggunakan library Error Reporting untuk Ruby.

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.

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 ini:

# 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

Error Reporting 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 kode 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 Penulis Error Reporting (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.

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

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

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

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 ini:

# 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

Error Reporting 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 kode 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 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.