Ruby
Sentry's Ruby SDK allows users to report messages, exceptions, and tracing events.
The SDK supports Ruby 2.4+ and the most recent JRuby versions. It also integrates with popular frameworks and libraries via library-specific gems.
On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.
Using a framework?
Get started using a guide listed in the right sidebar.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Install
Sentry captures data by using an SDK within your application’s runtime.
Add the sentry-ruby
gem to your Gemfile
:
Gemfile
gem "sentry-ruby"
Configure
Configuration should happen as early as possible in your application's lifecycle.
Sentry.init do |config|
config.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'
config.breadcrumbs_logger = [:sentry_logger, :http_logger]
# To activate performance monitoring, set one of these options.
# We recommend adjusting the value in production:
config.traces_sample_rate = 0.5
# or
config.traces_sampler = lambda do |context|
0.5
end
end
Verify
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:
Sentry.capture_message("test message")
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
- Package:
- gem:sentry-ruby
- Version:
- 5.18.2
- Repository:
- https://github.com/getsentry/sentry-ruby