You can send error reports to Error Reporting from Ruby applications by using the Error Reporting library for Ruby.
Error Reporting is integrated with some Google Cloud services, such as App Engine, Compute Engine, and Google Kubernetes Engine. Error Reporting displays the errors that are logged to Cloud Logging by applications running on those services. For more information, go to Running on Google Cloud Platform on this page.
Before you begin
- 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.
In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.
Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.
- Enable the Error Reporting API .
- Install Ruby 2.2+ or greater.
Installing the client library
Error Reporting library for Ruby lets you monitor and view errors reported by Ruby applications running nearly anywhere.
Add the Google Cloud's operations suite gem to your Gemfile:
Use Bundler to install the gem:
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
Configuring the client library
You can customize the behavior of the Error Reporting library for Ruby. See the library's configuration for a list of possible configuration options.
Reporting errors in Rack-based frameworks
The 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
require "google/cloud/error_reporting" begin raise "Raise an exception for Error Reporting." rescue StandardError => e Google::Cloud::ErrorReporting.report e end
Running on Google Cloud
You can configure Error Reporting for Ruby on the following Google Cloud environments.
App Engine flexible environment
The 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.
Google Kubernetes Engine
On GKE, you must add the
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
When using Compute Engine VM instances, add the
access scope to each instance. When creating a new instance through the
Google Cloud Console, you can do this in the Identity and API access section
of the Create Instance panel. Use the Compute Engine default service
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
Running locally and elsewhere
To use the Error Reporting library for Ruby outside of Google Cloud, 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 Google Cloud project ID and appropriate service account credentials directly to the 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 Identity and Access Management roles, go to Access control guide.
Using Ruby on Rails configuration interface
To use the 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 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 Google Cloud's operations suite 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 Cloud Console Error Reporting dashboard.
For more information, see Viewing Errors.