Skip to content

RN: Adds reactNavigationIntegration useDispatchedActionData option doc #14080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+5 −0
Open

RN: Adds reactNavigationIntegration useDispatchedActionData option doc #14080

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9af533
Adds `reactNavigationIntegration` `useDispatchedActionData` option d…
antonis Jun 19, 2025
03db04e
Merge branch 'master' into antonis/rn-useDispatchedActionData
antonis Jul 2, 2025
d329411
Merge branch 'master' into antonis/rn-useDispatchedActionData
antonis Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/platforms/react-native/tracing/instrumentation/react-navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Sentry.reactNavigationIntegration({
enableTimeToInitialDisplay: true, // default: false
routeChangeTimeoutMs: 1_000, // default: 1_000
ignoreEmptyBackNavigationTransactions: true, // default: true
useDispatchedActionData: true, // default: false
});
```

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

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`.

### useDispatchedActionData

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`.

## Notes

- 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.
Expand Down
Loading