Raven-Ruby

A client and integration layer for the Sentry error reporting API.

Requirements

We test on Ruby MRI 1.8.7, 1.9.2, 1.9.3 and 2.0.0. Other versions/VMs are untested but we will accept pull requests to support them.

Installation

gem "sentry-raven" #, :github => "getsentry/raven-ruby"

Usage

The easiest way to configure Raven is by setting the SENTRY_DSN environment variable.

You'll find this value on your project settings page, and it should resemble something like https://secret:public@app.getsentry.com/9999.

For alternative configuration methods, and other options see Configuration.

Rails 3

In Rails 3, Sentry will "just work," capturing any exceptions thrown in your app. All Rails integrations also have mixed-in methods for capturing exceptions you've rescued yourself inside of controllers:

 # ...
 rescue => exception
   capture_exception(exception) # or capture_message('Flux overload')
   flash[:error] = 'Your flux capacitor is overloaded!'
 end

Rails 2

No support for Rails 2 yet, but it is being worked on.

Rack

Add use Raven::Rack to your config.ru (or other rackup file).

Sinatra

Like any other Rack middleware, add use Raven::Rack to your Sinatra app.

Capturing Events

Many implementations will automatically capture uncaught exceptions (such as Rails, Sidekiq or by using the Rack middleware). Sometimes you may want to catch those exceptions, but still report on them.

Several helpers are available to assist with this.

Capture Exceptions in a Block

Raven.capture do
  # capture any exceptions which happen during execution of this block
  1 / 0
end

Capture an Exception by Value

begin
  1 / 0
rescue ZeroDivisionError => exception
  Raven.capture_exception(exception)
end

Additional Context

Additional context can be passed to the capture methods.

Raven.capture_message("My event", {
  :logger => 'logger',
  :extra => {
    'my_custom_variable' => 'value'
  },
  :tags => {
    'environment' => 'production',
  }
})

The following attributes are available:

logger: the logger name to record this event under
level: a string representing the level of this event (fatal, error, warning, info, debug)
server_name: the hostname of the server
tags: a mapping of tags describing this event
extra: a mapping of arbitrary context

Configuration

SENTRY_DSN

After you complete setting up a project, you'll be given a value which we call a DSN, or Data Source Name. It looks a lot like a standard URL, but it's actually just a representation of the configuration required by Raven (the Sentry client). It consists of a few pieces, including the protocol, public and secret keys, the server address, and the project identifier.

With Raven, you may either set the SENTRY_DSN environment variable (recommended), or set your DSN manually in a config block:

Raven.configure do |config|
  config.dsn = 'http://public:secret@example.com/project-id'
end

Environments

By default events will be sent to Sentry in all environments except 'test', 'development', and 'cucumber'.

You can configure Raven to run only in certain environments by configuring the environments whitelist. For example, to only run Sentry in production:

Raven.configure do |config|
  config.environments = %w[ production ]
end

Sentry automatically sets the current environment to RAILS_ENV, or if it is not present, RACK_ENV. If you are using Sentry outside of Rack or Rails, you'll need to set the current environment yourself:

Raven.configure do |config|
  config.current_environment = 'my_cool_environment'
end

Excluding Exceptions

If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.

In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.

Raven.configure do |config|
  config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
end

You can find the list of exceptions that are excluded by default in Raven::Configuration::IGNORE_DEFAULT. Remember you'll be overriding those defaults by setting this configuration.

SSL Verification

By default SSL certificate verification is disabled in the client. This choice was made due to root CAs not being commonly available on systems. If you'd like to change this, you can enable verification by passing the ssl_verification flag:

Raven.configure do |config|
  config.ssl_verification = true

Sanitizing Data (Processors)

If you need to sanitize or pre-process (before its sent to the server) data, you can do so using the Processors implementation. By default, a single processor is installed (Raven::Processor::SanitizeData), which will attempt to sanitize keys that match various patterns (e.g. password) and values that resemble credit card numbers.

To specify your own (or to remove the defaults), simply pass them with your configuration:

Raven.configure do |config|
  config.processors = [Raven::Processor::SanitizeData]
end

Testing Your Configuration

To ensure you've setup your configuration correctly we recommend running the included rake task::

$ rake raven:test[https://public:secret@app.getsentry.com/3825]
Client configuration:
-> server: https://app.getsentry.com
-> project_id: 3825
-> public_key: public
-> secret_key: secret

Sending a test event:
-> event ID: 033c343c852b45c2a3add98e425ea4b4

Done!

A couple of things to note:

This won't test your environment configuration. The test CLI forces the your coniguration to represent itself as if it were running in the production env.
If you're running within Rails (or anywhere else that will bootstrap the rake environment), you should be able to omit the DSN argument.

Contributing

Bootstrap

$ bundle install

Running the test suite

$ rake spec

Resources

Bug Tracker
Code
Mailing List
IRC (irc.freenode.net, #sentry)

aaronrussell/raven-ruby