Rails integration guide

Add Bugsnag to your Ruby on Rails projects to automatically monitor exceptions in your Rails applications.

New to Bugsnag? Create an account now.

Installation

Add the bugsnag gem to your Gemfile:

bundle add bugsnag

Basic configuration

Run our generator to create the config/initializers/bugsnag.rb configuration file and set your project’s integration API key:

$ rails generate bugsnag YOUR_API_KEY_HERE

Alternatively, you can set the BUGSNAG_API_KEY environment variable.

You can find your integration API key immediately after creating a new project from your Bugsnag dashboard, or later on your project’s settings page.

Further configuration

If you’d like to configure Bugsnag further, check out the configuration options reference.

Reporting unhandled exceptions

After completing installation and basic configuration, unhandled exceptions in your Rails app will be automatically reported to your Bugsnag dashboard.

Exceptions in Sidekiq, Resque, Delayed Job, Mailman, and Rake will also be automatically reported.

Reporting handled exceptions

Reporting handled exceptions can be accomplished as follows:

begin
  raise 'Something went wrong!'
rescue => exception
  Bugsnag.notify(exception)
end

Adding diagnostics or adjusting severity

It can often be helpful to adjust the severity or attach custom diagnostics to handled exceptions. For more information, see reporting handled errors.

Avoiding re-notifying exceptions

Sometimes after catching and notifying a handled exception you may want to re-raise the exception to be dealt with by your standard error handlers without sending an automatic exception to Bugsnag. This can be accomplished by setting a skip_bugsnag property on the exception to true as follows:

begin
  raise 'Something went wrong!'
rescue CustomException => exception
  Bugsnag.notify(exception)
  exception.skip_bugsnag = true

  # Now this won't be sent a second time by the exception handlers
  raise exception
end

Sending diagnostic data

Automatically captured diagnostics

Bugsnag will automatically capture and attach the following diagnostic data to every exception report:

  • A full stacktrace
  • Request information, including ip, headers, URL, HTTP method, and HTTP params
  • Session data
  • Release stage (production, beta, staging, etc)
  • Hostname

Attaching custom diagnostics

It can often be helpful to attach application-specific diagnostic data to exception reports. This can be accomplished as follows:

class ApplicationController < ActionController::Base
  before_bugsnag_notify :add_diagnostics_to_bugsnag

  # Your controller code here

  private
  def add_diagnostics_to_bugsnag(report)
    report.add_tab(:diagnostics, {
      product: current_product.name
    })
  end
end

For more information, see customizing error reports.

Identifying users

In order to correlate errors with customer reports, or to see a list of users who experienced each error, it is helpful to capture and display user information:

If you are using the Devise, Warden, or Clearance authentication frameworks, we will automatically capture information about the currently authenticated user. Otherwise, you can set this information as follows:

class ApplicationController < ActionController::Base
  before_bugsnag_notify :add_user_info_to_bugsnag

  # Your controller code here

  private
  def add_user_info_to_bugsnag(report)
    report.user = {
      email: current_user.email,
      name: current_user.name,
      id: current_user.id
    }
  end
end

For more information, see customizing error reports.

Session tracking

Bugsnag tracks the number of “sessions” that happen within your application. This allows you to compare stability scores between releases and helps you to understand the quality of your releases.

Sessions are captured and reported by default. This behaviour can be disabled using the auto_capture_sessions configuration option.

When enabled, sessions are automatically captured whenever a request is made to the Rails server.

To control what is deemed a session, disable automatic session capturing as detailed above, then call Bugsnag.start_session when appropriate for your application.

Logging breadcrumbs

In order to understand what happened in your application before each error, it can be helpful to leave short log statements that we call breadcrumbs. By default, the last 25 breadcrumbs are attached to an error report to help diagnose what events lead to the error. Captured breadcrumbs are shown on your Bugsnag dashboard as a part of the error report.

Automatically captured breadcrumbs

By default, Bugsnag captures common events including:

  • Error reports
  • Mongo queries
  • ActionController processing events
  • ActiveJob perform events
  • ActiveSupport cache events
  • ActionCable events
  • ActiveRecord SQL events
  • ActionView rendering events
  • ActionMail delivery events

A full breakdown of automatically captured events can be found here. You can prevent the capture of certain automatically captured breadcrumbs by removing the type from the enabled_automatic_breadcrumb_types configuration array.

Attaching custom breadcrumbs

Leaving a breadcrumb is accomplished using the leave_breadcrumb method:

Bugsnag.leave_breadcrumb "Something happened!"

When logging breadcrumbs, we’ll keep track of the timestamp, and show both the message and timestamp on your dashboard.

Additional data can optionally be attached to breadcrumbs:

meta_data = {
    :userId => get_current_user.id,
    :authLevel => get_current_user.get_level
}
Bugsnag.leave_breadcrumb("User logged in", meta_data, Bugsnag::Breadcrumbs::USER_BREADCRUMB_TYPE)

The breadcrumb name will be trimmed to be 30 characters maximum, and all meta data must be of the Numeric, String, TrueClass, or FalseClass types, or nil.

Filtering breadcrumbs

Both automatically and manually created breadcrumbs can be filtered to remove sensitive data, or be ignored completely.

Callbacks can be registered by adding them to the before_breadcrumb_callbacks array in the configuration. This callback will have access to each breadcrumb, and can modify it or prevent collection using the methods described in the breadcrumb object:

config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
  # Ignores all breadcrumbs of a certain type
  breadcrumb.ignore! if breadcrumb.type == Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE

  # Removes any collected breadcrumb meta data
  breadcrumb.meta_data = {}
end

Similarly to the report meta data, the breadcrumb’s meta data will be filtered based on the meta_data_filters before delivery.

Tracking releases

By sending your application version to us when you release a new version of your app, you’ll be able to see which release each error was introduced or seen in.

Ensure you’ve set your app version within the application:

Bugsnag.configure do |config|
  config.app_version = '1.3.0'
end

Set up a build tool integration to enable linking to code in your source control provider from the releases dashboard, timeline annotations, and stack traces.

Catching JavaScript errors

Catch and report errors in your client-side JavaScript with the Web browser JavaScript guide