feat(react-native): Document includeWebReplay and includeFeedback Metro options#17423
Merged
feat(react-native): Document includeWebReplay and includeFeedback Metro options#17423
Conversation
…ro options Adds a "Reduce Bundle Size" section to the React Native Metro page describing how to exclude the web Session Replay and User Feedback packages from the bundle for users who don't need them. includeFeedback is new in the upcoming Sentry React Native SDK release (getsentry/sentry-react-native#6025). includeWebReplay has existed for a while but was previously undocumented.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
antonis
commented
Apr 21, 2026
10 tasks
| | Option | Default | Effect when set to `false` | | ||
| | ------------------ | ------- | ------------------------------------------------------------------------ | | ||
| | `includeWebReplay` | `true` | Excludes `@sentry/replay` and `@sentry-internal/replay` from the bundle. | | ||
| | `includeFeedback` | `true` | Excludes `@sentry-internal/feedback` from the bundle. | |
Collaborator
There was a problem hiding this comment.
we may change includeFeedback to includeWebReplay if getsentry/sentry-react-native#6025 (comment) is accepted
|
|
||
| ### Reduce Bundle Size | ||
|
|
||
| If you're not using the Session Replay or User Feedback features, you can exclude their web-only packages from the bundle by opting out via the Metro Plugin options. When set to `false`, the Sentry Metro Plugin resolves the matching Sentry sub-packages to an empty module so they're not included in the output bundle. |
Collaborator
There was a problem hiding this comment.
Shouldn't we simplify this mentioning if users aren't targeting React Native for web, here is an idea:
Suggested change
| If you're not using the Session Replay or User Feedback features, you can exclude their web-only packages from the bundle by opting out via the Metro Plugin options. When set to `false`, the Sentry Metro Plugin resolves the matching Sentry sub-packages to an empty module so they're not included in the output bundle. | |
| If you're not using the React Native for Web, you can exclude their web-only packages like session replay and user feedback from the bundle by opting out via the Metro Plugin options. When set to false, the Sentry Metro Plugin resolves the matching Sentry sub-packages to an empty module so they're not included in the output bundle. |
coolguyzone
approved these changes
Apr 23, 2026
- Rename `includeFeedback` to `includeWebFeedback` (mirrors the SDK rename in getsentry/sentry-react-native#6025 after @lucas-zimerman's feedback). - Reword the intro to frame the bundle-size options around "not targeting React Native for Web", per @lucas-zimerman's suggestion.
coolguyzone
pushed a commit
that referenced
this pull request
May 1, 2026
…ro options (#17423) ## DESCRIBE YOUR PR Adds a new \"Reduce Bundle Size\" section to the [React Native Metro](https://docs.sentry.io/platforms/react-native/manual-setup/metro/) page describing how to exclude the web Session Replay and User Feedback packages from the bundle for users who don't need them. Covers two Metro Plugin options: - \`includeWebReplay\` — already exists in the SDK but was previously undocumented. - \`includeFeedback\` — new in an upcoming Sentry React Native SDK release, added in [getsentry/sentry-react-native#6025](getsentry/sentry-react-native#6025) (closes [getsentry/sentry-react-native#5629](getsentry/sentry-react-native#5629)). > Note: there's a \`TODO\` in the doc pinning the exact SDK version for \`includeFeedback\` — will update before merge once the SDK release is cut. ## IS YOUR CHANGE URGENT? - [ ] Urgent deadline (GA date, etc.): - [ ] Other deadline: - [x] None: Not urgent, can wait up to 1 week+⚠️ Should be merged after getsentry/sentry-react-native#6025 is shipped ## 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 - [ ] 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) - [ ] SDK version for \`includeFeedback\` confirmed in the Alert callout ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Adds a new "Reduce Bundle Size" section to the React Native Metro page describing how to exclude the web Session Replay and User Feedback packages from the bundle for users who don't need them.
Covers two Metro Plugin options:
IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
EXTRA RESOURCES