Set Up Tracing
Learn how to enable tracing in your app and discover valuable performance insights of your application.
With tracing, Sentry is able to connect events from different parts of your game as well as the backend. Helping debugging hard problems that involve issues in C# scripts as well as native layers of all platforms. It also allows tracking your game's performance, measuring metrics like game initialization time, time spent by game objects and ANRs. Besides connecting different errors together, 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 Tracing 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 sample rate for transactions. Set the sample rate for your transactions by either:
- Setting a uniform sample rate for all transactions using the
TracesSampleRate
option in your SDK config to a number between0
and1
. (For example, to send 20% of transactions, setTracesSampleRate
to0.2
.) - Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the
TracesSampler
config option.
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;
Learn more about tracing options, how to use the TracesSampler function, or how to sample 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 TracesSampleRate
to 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.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").