docs(react-native): Document Session Replay network details options#18423
Open
alwx wants to merge 1 commit into
Open
docs(react-native): Document Session Replay network details options#18423alwx wants to merge 1 commit into
alwx wants to merge 1 commit into
Conversation
Add a Network Details section to the React Native Session Replay docs, covering the new `networkDetailAllowUrls`, `networkDetailDenyUrls`, `networkCaptureBodies`, `networkRequestHeaders` and `networkResponseHeaders` options on `mobileReplayIntegration`. Mirrors the structure of the existing Apple and Android Session Replay configuration pages (allow/deny list, defaults, header opt-in, body capture opt-in, 150 KB cap, server-side scrubbing note) and calls out the React Native-specific constraints \u2014 XHR-only support for now (covers axios), authorization-like headers always stripped,\n`UNPARSEABLE_BODY_TYPE` for binary bodies. Related: getsentry/sentry-react-native#6288
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
10 tasks
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| |-----|------|---------|-------------| | ||
| | `networkDetailAllowUrls` | `(string \| RegExp)[]` | `[]` | URL patterns to enable capture of request/response headers (and bodies, when `networkCaptureBodies` is `true`). String patterns use substring matching; `RegExp` is matched via `.test(url)`. | | ||
| | `networkDetailDenyUrls` | `(string \| RegExp)[]` | `[]` | URL patterns to **never** enable capture for, even if an allow pattern matches them. | | ||
| | `networkCaptureBodies` | `boolean` | `false` | Controls whether request and response bodies are captured for allow-listed URLs. Disabled by default since bodies can contain sensitive payloads — opt in explicitly. | |
Contributor
There was a problem hiding this comment.
Bug: The default value for networkCaptureBodies is documented as false for React Native, which is inconsistent with the true default documented for other Sentry SDKs.
Severity: MEDIUM
Suggested Fix
Verify the actual default value of networkCaptureBodies in the React Native SDK implementation. Update the documentation to reflect the correct default value. If false is an intentional choice for React Native, consider adding a note explaining the divergence from other platforms.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/react-native/session-replay/index.mdx#L243
Potential issue: The documentation for the `networkCaptureBodies` option in React Native
Session Replay states that its default value is `false`. This contradicts the
documentation for all other major Sentry SDKs (Apple/iOS, Android, JavaScript), where
the default is documented as `true`. This inconsistency can mislead developers, causing
them to either miss capturing network body data they expect to be collected by default,
or to add unnecessary configuration if the documentation is incorrect and the actual
default is `true`.
Did we get this right? 👍 / 👎 to inform future reviews.
antonis
approved these changes
Jun 16, 2026
antonis
left a comment
antonis
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Let's merge after shipping getsentry/sentry-react-native#6288 🎸
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
2 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
Add a Network Details section to the React Native Session Replay docs, covering the new options on
mobileReplayIntegrationintroduced in getsentry/sentry-react-native#6288:networkDetailAllowUrlsnetworkDetailDenyUrlsnetworkCaptureBodiesnetworkRequestHeadersnetworkResponseHeadersAvailable in React Native SDK 8.15.0 and laterwhich is what's gonna be released next.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
LEGAL BOILERPLATE
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