Skip to content

docs(react-native): Document Session Replay runtime controls - #19393

Open
antonis wants to merge 1 commit into
masterfrom
antonis/docs-replay-runtime-controls-rn
Open

antonis wants to merge 1 commit into
masterfrom
antonis/docs-replay-runtime-controls-rn

Conversation

@antonis

@antonis antonis commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

⚠️ Should be merged after getsentry/sentry-react-native#6703 is released

Documents the new Session Replay runtime controls for React Native, exposed through Sentry.getReplay(). Adds a "Manually Controlling Session Replay" section to the React Native Session Replay page covering:

  • start() / startBuffering() — begin recording (session or buffer mode) regardless of sample rates
  • stop() — stop recording and end the session
  • pause() / resume() — pause/resume recording without ending the session (iOS/Android only; no-ops on React Native Web)
  • flush({ continueRecording }) — upload buffered data, optionally stopping afterwards
  • getReplayId() — read the active replay ID

The section is styled after the existing JavaScript understanding-sessions docs and adapted to the React Native API surface and platform differences.

Depends on SDK PR getsentry/sentry-react-native#6703 (not yet released). Keeping this as a draft until the SDK ships.

Important

The availability line currently reads Available in React Native SDK 8.27.0 and later — this is a placeholder and must be updated to the actual release version before merge. It's marked with a {/* TODO */} comment in the source.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

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

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

🤖 Generated with Claude Code

@vercel

vercel Bot commented Sep 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 14, 2026 10:13am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 14, 2026 10:13am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 14, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 14, 2026 10:04
Add a "Manually Controlling Session Replay" section to the React Native
Session Replay docs covering the runtime controls exposed via
Sentry.getReplay(): start, startBuffering, stop, pause, resume, flush
(with continueRecording), and getReplayId.

Depends on SDK PR getsentry/sentry-react-native#6703; the availability
version is a placeholder to be confirmed at release.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment thread docs/platforms/react-native/common/session-replay/index.mdx

@lucas-zimerman lucas-zimerman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document and validate React Native Replay runtime controls

2 participants