Skip to content

docs(replay): Document the two capture strategies - #5848

Open
runningcode wants to merge 1 commit into
mainfrom
no/document-capture-strategies
Open

docs(replay): Document the two capture strategies#5848
runningcode wants to merge 1 commit into
mainfrom
no/document-capture-strategies

Conversation

@runningcode

@runningcode runningcode commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

📜 Description

Adds a short KDoc block to SessionCaptureStrategy and BufferCaptureStrategy explaining what each one does and how they differ. Each links to the other. Docs only — no behavior change.

📝 Checklist

  • I added GH Issue ID & Linear ID
  • I added tests to verify the changes. — n/a, comments only
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog. — no user-facing change
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

#skip-changelog

SessionCaptureStrategy and BufferCaptureStrategy differ only in when a
recorded segment is sent, but nothing at the top of either class said so.
Add a short KDoc to each pointing at the other, covering how the mode is
selected, when segments are sent, and why ReplayIntegration pauses session
mode while buffer mode keeps recording.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
@runningcode
runningcode marked this pull request as ready for review July 28, 2026 16:01
@sentry

sentry Bot commented Jul 28, 2026

Copy link
Copy Markdown

📲 Install Builds

Android

🔗 App Name App ID Version Configuration
SDK Size io.sentry.tests.size 8.50.0 (1) release

⚙️ sentry-android Build Distribution Settings

@github-actions

Copy link
Copy Markdown
Contributor

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 398.09 ms 472.28 ms 74.19 ms
Size 0 B 0 B 0 B

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
05aa61d 326.06 ms 385.46 ms 59.40 ms
bb0ff41 315.84 ms 350.76 ms 34.92 ms
806307f 357.85 ms 424.64 ms 66.79 ms
d501a7e 307.33 ms 341.94 ms 34.61 ms
0ee65e9 321.06 ms 361.24 ms 40.18 ms
ed33deb 334.19 ms 362.30 ms 28.11 ms
9fbb112 401.87 ms 515.87 ms 114.00 ms
b8bd880 314.56 ms 336.50 ms 21.94 ms
5b1a06b 315.40 ms 353.33 ms 37.94 ms
6edfca2 316.43 ms 398.90 ms 82.46 ms

App size

Revision Plain With Sentry Diff
05aa61d 0 B 0 B 0 B
bb0ff41 0 B 0 B 0 B
806307f 1.58 MiB 2.10 MiB 533.42 KiB
d501a7e 0 B 0 B 0 B
0ee65e9 0 B 0 B 0 B
ed33deb 1.58 MiB 2.13 MiB 559.52 KiB
9fbb112 1.58 MiB 2.11 MiB 539.18 KiB
b8bd880 1.58 MiB 2.29 MiB 722.92 KiB
5b1a06b 0 B 0 B 0 B
6edfca2 1.58 MiB 2.13 MiB 559.07 KiB

@romtsn romtsn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

good idea!

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.

2 participants