Set Up
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.
Enable Tracing
Prior Versions
If you use a version of our SDK prior to verison 3.0.0
, you will need to include the ReactNativeTracing
integration to use automatic instrumentation. You do not need to do this in versions 3.0.0
and above.
import * as Sentry from "@sentry/react-native";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [
new Sentry.ReactNativeTracing({
tracingOrigins: ["localhost", "my-site-url.com", /^\//],
// ... other options
}),
],
});
Configure the Sample Rate
Once you configure the sample rate, tracing will be enabled in your app. 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.
import * as Sentry from "@sentry/react-native";
// Unlike Sentry on other platforms, you do not need to import anything to use tracing on React Native
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// To set a uniform sample rate
tracesSampleRate: 0.2
// Alternatively, to control sampling dynamically
tracesSampler: samplingContext => { ... }
});
Learn more about how the options work in Sampling Transactions.
Verify
Verify that performance monitoring is working correctly by using our automatic instrumentation or by starting and finishing a transaction using custom instrumentation.
While you're testing, set tracesSampleRate
to 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 tracesSampleRate
value, or switching to using tracesSampler
to dynamically sample and filter your transactions.
Next Steps:
- Package:
- npm:@sentry/react-native
- Version:
- 5.27.0
- Repository:
- https://github.com/getsentry/sentry-react-native