You can send error reports to Error Reporting from Ruby applications by using the Error Reporting library for Ruby. Use the Error Reporting library for Ruby to create error groups for the following cases:
- A log bucket that contains your log entries has customer-managed encryption keys (CMEK).
- The log bucket satisfies one of the following:
- The log bucket is stored in the same project where the log entries originated.
- The log entries were routed to a project, and then that project stored those log entries in a log bucket that it owns.
- You want to report custom error events.
Error Reporting is integrated with some Google Cloud services, such as Cloud Functions and 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 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
- 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 Google Cloud project.
-
Enable the Error Reporting API .
-
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 Google Cloud project.
-
Enable the Error Reporting API .
- Install Ruby 2.2+ or greater.
Install the client library
The Error Reporting library for Ruby lets you monitor and view errors reported by Ruby applications running nearly anywhere.
-
Add the
google-cloud-error_reporting
gem to your Gemfile:gem "google-cloud-error_reporting"
-
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:
For more information on installation, read the documentation for the Error Reporting library for Ruby. You can also report issues using the issue tracker.
Configure 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.
Run apps on Google Cloud
To create error groups by using
projects.events.report
, your service account requires the
Error Reporting Writer role (roles/errorreporting.writer
).
Some Google Cloud services automatically grant the
Error Reporting Writer role (roles/errorreporting.writer
) to the appropriate
service account. However, you must grant this role to the appropriate service
account for some services.
App Engine flexible environment
App Engine grants the
Error Reporting Writer role (roles/errorreporting.writer
)
to your default service account automatically.
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
To use Error Reporting with Google Kubernetes Engine, do the following:
Ensure that the service account to be used by your container has been granted the Error Reporting Writer role (
roles/errorreporting.writer
).You can use either the Compute Engine default service account or a custom service account.
For information about granting roles, see Manage access to projects, folders, and organizations.
Create your cluster and grant the cluster the
cloud-platform
access scope.For example, the following create command specifies the
cloud-platform
access scope and a service account:gcloud container clusters create CLUSTER_NAME --service-account SERVICE_ACCT_NAME --scopes=cloud-platform
Compute Engine
To use Error Reporting with Compute Engine VM instances, do the following:
Ensure that the service account to be used by your VM instance has been granted the Error Reporting Writer role (
roles/errorreporting.writer
).You can use either the Compute Engine default service account or a custom service account.
For information about granting roles, see Manage access to projects, folders, and organizations.
-
In the Google Cloud console, go to the VM instances page:
If you use the search bar to find this page, then select the result whose subheading is Compute Engine.
Select the VM instance that you want to receive the
cloud-platform
access scope.Click Stop, and then click Edit.
In the Identity and API access section, select a service account that has the Error Reporting Writer role (
roles/errorreporting.writer
).In the Access scopes section, select Allow full access to all Cloud APIs, and then save your changes.
Click Start/Resume.
Cloud Functions
Cloud Run functions grants the
Error Reporting Writer role (roles/errorreporting.writer
)
to your default service account automatically.
The Error Reporting library for Ruby can be used without needing to explicitly provide credentials.
Cloud Run functions is configured to use Error Reporting automatically. Unhandled JavaScript exceptions will appear in Logging and be processed by Error Reporting without needing to use the Error Reporting library for Ruby.
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:
You can also set shared configuration for all Stackdriver gems using the following:
Error Reporting is enabled by default when Rails is running in production mode. To enable Error Reporting in development mode, add the following:
Using instrumentation configuration interface
To use the Error Reporting library for Ruby in other Rack-based applications, provide the parameters through the configuration interface:
You can also set shared configuration for all Google Cloud Observability gems using the following:
Example
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 thereport
method, as seen in the
following example:
Run apps in a local development environment
To use the Error Reporting library for Ruby in a local development environment, such as running the library on your own workstation, you must provide your Error Reporting library for Ruby with the local application default credentials. For more information, see Authenticate to Error Reporting.
To use the Ruby samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create local authentication credentials for your user account:
gcloud auth application-default login
For more information, see Set up authentication for a local development environment.
The
projects.events.report
method also
supports API keys.
If you want to use API keys for authentication, you do not need
to set up a local Application Default Credentials file.
For more information, see
Create an API key
in the Google Cloud authentication documentation.
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:
You can also set shared configuration for all Stackdriver gems using the following:
Error Reporting is enabled by default when Rails is running in production mode. To enable Error Reporting in development mode, add the following:
Using instrumentation configuration interface
To use the Error Reporting library for Ruby in other Rack-based applications, provide the parameters through the configuration interface:
You can also set shared configuration for all Google Cloud Observability gems using the following:
Viewing error reports
In the Google Cloud console, go to the Error Reporting page:
You can also find this page by using the search bar.
For more information, see Viewing Errors.