Setting Up Error Reporting for Ruby

You can send error reports to Stackdriver Error Reporting from Ruby applications by using the Stackdriver Error Reporting library for Ruby.

Error Reporting is integrated with some Google Cloud Platform services, such as App Engine, Compute Engine, and Google Kubernetes Engine. Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those services. For more information, go to Running on Google Cloud Platform on this page.

You can also send error data to Error Reporting using Logging. For information on the data formatting requirements, read Formatting error messages in Logging.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a Google Cloud Platform project.

    Go to the Manage resources page

  3. Asegúrate de tener habilitada la facturación para tu proyecto.

    Aprende a habilitar la facturación

  4. Habilita las Error Reporting API necesarias.

    Habilita las API

  5. Install Ruby 2.2+ or greater.

Installing the client library

Stackdriver Error Reporting library for Ruby lets you monitor and view errors reported by Ruby applications running nearly anywhere.

  1. Add the Stackdriver gem to your Gemfile:

    gem "stackdriver"
  2. Use Bundler to install the gem:

    bundle install

Enabling the library

If you're using Ruby on Rails, Bundler automatically loads the library into your application when it starts.

Other Rack-based applications can use the Rack Middleware provided by the library:

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

For more information on installation, read the documentation for the Stackdriver Error Reporting library for Ruby. You can also report issues using the issue tracker.

Configuring the client library

You can customize the behavior of the Stackdriver Error Reporting library for Ruby. See the library's configuration for a list of possible configuration options.

Reporting errors

Reporting errors in Rack-based frameworks

The Stackdriver Error Reporting library for Ruby makes it easy to integrate Error Reporting into popular Rack-based Ruby web frameworks such as Ruby on Rails and Sinatra. When the library is enabled, it automatically reports exceptions captured from the application's Rack stack.

Reporting errors manually

You can manually report an error by calling the report method, as seen in the following example:

require "google/cloud/error_reporting"

begin
  raise "Raise an exception for Error Reporting."
rescue StandardError => exception
  Google::Cloud::ErrorReporting.report exception
end

Running on Google Cloud Platform

Using the Stackdriver Error Reporting library for Ruby requires the Cloud Identity and Access Management Error Reporting Writer role. Most GCP computing platforms provide this role by default.

App Engine flexible environment

App Engine grants the Error Reporting Writer role by default.

The Stackdriver Error Reporting library for Ruby can be used without needing to explicitly provide credentials.

Error Reporting is automatically enabled for App Engine flexible environment applications. No additional setup is required.

GKE

On GKE, you must add the cloud-platform access scope when creating the cluster, as the following example command shows:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Error Reporting Writer role in the IAM & admin section of the GCP Console.

Running locally and elsewhere

To use the Stackdriver Error Reporting library for Ruby outside of GCP, including running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for Ruby.

You can create and obtain service account credentials manually. When specifying the Role field, use the Error Reporting Writer role. For more information on Cloud Identity and Access Management roles, go to Access control guide.

Using Ruby on Rails configuration interface

To use the Stackdriver Error Reporting library for Ruby with the Ruby on Rails framework, provide the parameters through the Ruby on Rails configuration interface:

# 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

You can also set shared configuration for all Stackdriver gems using the following:

# 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 is enabled by default when Rails is running in production mode. To enable Error Reporting in development mode, add the following:

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

Using instrumentation configuration interface

To use the Stackdriver Error Reporting library for Ruby in other Rack-based applications, provide the parameters through the configuration interface:

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

You can also set shared configuration for all Stackdriver gems using the following:

require "stackdriver"

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

Viewing error reports

After deployment, you can view error reports in the GCP Console Error Reporting dashboard.

Go to the Error Reporting dashboard

For more information, see Viewing Errors.

¿Te sirvió esta página? Envíanos tu opinión:

Enviar comentarios sobre…

Stackdriver Error Reporting
¿Necesitas ayuda? Visita nuestra página de asistencia.