If you’re on a legacy plan, you'll need to add transaction events to your subscription to use performance monitoring.
With performance monitoring, Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in Distributed Tracing.
If you’re adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
Sampling for transactions must also be configured before tracing is be enabled in your app. Set the sample rate for your transactions by either:
- Setting a uniform sample rate for all transactions using the
traces_sample_rateoption in your SDK config to a number between
1. (For example, to send 20% of transactions, set
- Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the
The two options are meant to be mutually exclusive. If you set both,
traces_sampler will take precedence.
Performance Monitoring is available for our updated Ruby SDK (
Sentry.init do |config| # set a uniform sample rate between 0.0 and 1.0 config.traces_sample_rate = 0.2 # or control sampling dynamically config.traces_sampler = lambda do |sampling_context| # sampling_context[:transaction_context] contains the information about the transaction # sampling_context[:parent_sampled] contains the transaction's parent's sample decision true # return value can be a boolean or a float between 0.0 and 1.0 end end
Learn more about how the options work in Sampling Transactions.
Test out tracing by starting and finishing a transaction, which you must do so transactions can be sent to Sentry. Learn how in our Custom Instrumentation content.
While you're testing, set
1.0, as that ensures that every transaction will be sent to Sentry.
Once testing is complete, we recommend lowering this value in production by either lowering your
traces_sample_rate value, or switching to using
traces_sampler to dynamically sample and filter your transactions.
- For requests that start in your backend, by adding a meta tag in your HTML template that contains tracing information.
Otherwise, backend services with Performance Monitoring connect automatically.