Ruby
Sentry's Ruby SDK allows users to report messages, exceptions, and
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.
Using a framework?
Get started using a guide listed in the right sidebar.
Don't already have an account and Sentry
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.
require 'sentry-ruby'
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 = 1.0
# 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
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- gem:sentry-ruby
- Version:
- 5.11.0
- Repository:
- https://github.com/getsentry/sentry-ruby