Set Up Profiling
Ruby Profiling is currently in beta. Beta features are still in progress and may have bugs. We recognize the irony.
With profiling, Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
Enable Performance Monitoring
Profiling depends on Sentry’s performance monitoring product being enabled beforehand. To enable performance monitoring in the SDK:
Sentry.init do |config|
config.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'
config.traces_sample_rate = 1.0
end
Check out the performance setup documentation for more detailed information on how to configure sampling. Setting the sample rate to 1.0 means all transactions will be captured.
Enable Profiling
Ruby profiling beta is available starting in SDK version 5.9.0
.
We use the stackprof
gem to collect profiles for Ruby.
First add stackprof
to your Gemfile
and make sure it is loaded before sentry-ruby
.
# Gemfile
gem 'stackprof'
gem 'sentry-ruby'
Then, make sure both traces_sample_rate
and profiles_sample_rate
are set and non-zero in your Sentry initializer.
# config/initializers/sentry.rb
Sentry.init do |config|
config.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0"
config.traces_sample_rate = 1.0
config.profiles_sample_rate = 1.0
end
The profiles_sample_rate
setting is relative to the traces_sample_rate
setting.
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.15.0
- Repository:
- https://github.com/getsentry/sentry-ruby