Set Up Performance
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.
First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:
- Setting a uniform sample rate for all transactions using the
TracesSampleRateoption 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,
TracesSampler will take precedence.
// Add this to the SDK initialization callback
// Example uniform sample rate: capture 100% of transactions
options.TracesSampleRate = 1.0;
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, you may want to set a lower
TracesSampleRate value, or switch to using
TracesSampler to selectively sample and filter your transactions, based on contextual data.