Skip to content

docs(android): Document manual Session Replay controls - #19077

Merged
romtsn merged 6 commits into
masterfrom
romtsn/docs/java-691-replay-controls
Aug 27, 2026
Merged

docs(android): Document manual Session Replay controls#19077
romtsn merged 6 commits into
masterfrom
romtsn/docs/java-691-replay-controls

Conversation

@romtsn

@romtsn romtsn commented Aug 19, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Document manual Session Replay control for Android, including:

  • Starting full-session or buffered recording independently of automatic sampling
  • Pausing recording on sensitive screens and resuming the same replay
  • Stopping a replay or flushing pending data in session, buffer, and stopped states
  • Disabling automatic recording with both sample rates set to 0.0
  • Calling the APIs safely from any thread

This gives Android developers the same manual lifecycle guidance available for the JavaScript SDK while documenting Android-specific behavior such as the 30-second buffer and persistent manual pause.

Depends on getsentry/sentry-java#5978.

Refs JAVA-691

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.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

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

Explain how to start full-session or buffered recording.

Document how pause, resume, stop, and flush affect the active replay.

Describe manual startup with zero sample rates and the remaining on-error sampling behavior.

Refs JAVA-691

Co-Authored-By: OpenAI Codex <noreply@openai.com>
@linear-code

linear-code Bot commented Aug 19, 2026

Copy link
Copy Markdown

JAVA-691

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview Aug 27, 2026 9:07am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Aug 27, 2026 9:07am

Request Review

@codeowner-assignment
codeowner-assignment Bot requested a review from a team August 19, 2026 13:15
@romtsn
romtsn marked this pull request as ready for review August 19, 2026 13:44

@runningcode runningcode left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, just some questions for my understanding!

Comment thread docs/platforms/android/session-replay/configuration.mdx Outdated
Comment thread docs/platforms/android/session-replay/index.mdx Outdated
Comment thread docs/platforms/android/session-replay/index.mdx Outdated
Comment thread docs/platforms/android/session-replay/configuration.mdx Outdated
Comment thread docs/platforms/android/session-replay/index.mdx Outdated
Comment thread docs/platforms/android/session-replay/index.mdx Outdated

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, thanks for updating.

Document that manual pause survives automatic replay restarts in the same process and requires an explicit resume.

Refs JAVA-691
Co-Authored-By: Codex <noreply@openai.com>
Explain when to keep replay paused and where to resume after deep links, notifications, or normal navigation.

Refs JAVA-691
Co-Authored-By: Codex <noreply@openai.com>
Address review wording and distinguish automatic buffered replay uploads from explicit flushes. Document how stop handles pending session and buffer data.

Refs JAVA-691

Co-Authored-By: Codex <noreply@openai.com>
Comment thread docs/platforms/android/session-replay/index.mdx
Use the SDK default of 30 seconds consistently for buffered Session Replay documentation.

Refs JAVA-691

Co-Authored-By: Codex <noreply@openai.com>
Comment thread docs/platforms/android/session-replay/index.mdx Outdated
Comment thread docs/platforms/android/session-replay/index.mdx Outdated
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
@romtsn
romtsn merged commit 48c815a into master Aug 27, 2026
21 of 22 checks passed
@romtsn
romtsn deleted the romtsn/docs/java-691-replay-controls branch August 27, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants