Raven-Ruby
A client and integration layer for the Sentry error reporting API.
This library is still forming, so if you are looking to just use it, please check back in a few weeks.
Installation
Add the following to your Gemfile
:
gem "sentry-raven", :git => "https://github.com/getsentry/raven-ruby.git"
Or install manually
$ gem install sentry-raven
Usage
Rails 3
Add a config/initializers/raven.rb
containing:
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
end
Rails 2
No support for Rails 2 yet.
Rack
Basic RackUp file.
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
end
use Raven::Rack
Sinatra
require 'sinatra'
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
end
use Raven::Rack
get '/' do
1 / 0
end
Other Ruby
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
# manually configure environment if ENV['RACK_ENV'] is not defined
config.current_environment = 'production'
end
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 helps 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.("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 underlevel
: a string representing the level of this event (fatal, error, warning, info, debug)server_name
: the hostname of the servertags
: a mapping of tags describing this eventextra
: a mapping of arbitrary context
Testing
$ bundle install
$ rake spec
Notifications in development mode
By default events will only be sent to Sentry if your application is running in a production environment. This is configured by default if you are running a Rack application (i.e. anytime ENV['RACK_ENV']
is set).
You can configure Raven to run in non-production environments by configuring the environments
whitelist:
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
config.environments = %w[ development production ]
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.
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
end
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:
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:[email protected]/project-id'
config.processors = [Raven::Processor::SanitizeData]
end
Command Line Interface
Raven includes a basic CLI for testing your DSN:
ruby -Ilib ./bin/raven test <DSN>
Resources
- Bug Tracker
- Code
- Mailing List
- IRC (irc.freenode.net, #sentry)