Skip to content

Commit 8bb01c1

Browse files
authored
RN: Adds reactNavigationIntegration useDispatchedActionData option doc (#14080)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR *Tell us what you're changing and why. If your PR **resolves an issue**, please link it so it closes automatically.* Adds `reactNavigationIntegration` `useDispatchedActionData` option documentation Implementation PR: getsentry/sentry-react-native#4684 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ This handles a report of missing doc on a support request ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent d65e115 commit 8bb01c1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/platforms/react-native/tracing/instrumentation/react-navigation.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Sentry.reactNavigationIntegration({
2121
enableTimeToInitialDisplay: true, // default: false
2222
routeChangeTimeoutMs: 1_000, // default: 1_000
2323
ignoreEmptyBackNavigationTransactions: true, // default: true
24+
useDispatchedActionData: true, // default: false
2425
});
2526
```
2627

@@ -36,6 +37,10 @@ This option will enable automatic measuring of the time to initial display for e
3637

3738
This ensures that transactions that are from routes that've been seen and don't have any spans, are not being sampled. This removes a lot of clutter, making it so that most back navigation transactions are now ignored. The default value is `true`.
3839

40+
### useDispatchedActionData
41+
42+
This option defines whether to use the dispatched action data to populate the transaction metadata. When set to true, the integration will filter out navigation actions that should not create spans. The default value is `false`.
43+
3944
## Notes
4045

4146
- This instrumentation supports React Navigation version 5 and above. Starting with SDK version 6, React Navigation version 4 will no longer be supported. Please upgrade.

0 commit comments

Comments
 (0)