Skip to content

docs(replay): Clarify mobile frame rate is not configurable - #19794

Open
sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/mobile-replay-fixed-framerate
Open

sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/mobile-replay-fixed-framerate

Conversation

@sansynx

@sansynx sansynx commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Fixes #17176

The mobile replay overview calls 1 FPS a default, and the performance page refers to a frame rate setting. Neither the Android nor Apple SDK exposes this as a supported public option. This updates both passages without changing the performance guidance

Checked against Android's replay options and Apple's replay options. Both pages compile as MDX. Rendered preview review is still pending

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

Thanks in advance for your help!

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

@vercel

vercel Bot commented Oct 4, 2026

Copy link
Copy Markdown

@sansynx is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 4, 2026
@sansynx
sansynx marked this pull request as ready for review October 4, 2026 06:57
Copilot AI balanced review requested due to automatic review settings October 4, 2026 06:57

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 4, 2026 06:57
@cursor

cursor Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks the published wording, page-load volume, and client errors on the replay docs pages. An issue escalates when the old wording remains or those errors rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Readers of the mobile replay overview now see that capture is at most one frame per second. The performance page now says the public SDK options do not expose a frame-rate setting. The change is live after sentry-docs deploys to production. The pages are static MDX. No flag gates them.

Risk

Broken MDX can make those two pages fail to render. Readers then cannot open the mobile replay docs. If the old sentences remain, readers still think they can set FPS in the public SDK. This change does not alter SDK code or replay ingest.

Intended effect

Sentry does not record page copy. Confirm the new sentences on the published pages. Absent means either URL still shows the old sentences while the pages still load.

Signal Baseline Rule Source
Misleading copy that calls 1 FPS a default or a frame-rate setting Both production pages still contain that copy. Measured at 2026-10-04T06:58Z. After deploy, both pages must drop those sentences. Hold at zero pages with the old copy. Live GET of /product/session-replay/mobile/ and /product/session-replay/mobile/performance-overhead/. Fixes issues/17176

The overview must contain this sentence: Mobile replay captures at most 1 frame per second. The performance page must contain this sentence: the frame rate is not configurable through the public SDK options.

Regression watch

A bad MDX ship can 404 these pages or throw in the page shell. Watch the two changed paths and the sibling replay product pages. The last 24 hours include Sunday. Volume is lower than the seven-day mix.

Signal Baseline Rule Source
Client errors on url:*/product/session-replay/mobile* 1 event in 2026-10-03T06:58:00Z to 2026-10-04T06:58:00Z. 3 events in 2026-09-27T06:58:00Z to 2026-10-04T06:58:00Z. All three were Event: Event \Event` (type=error) captured as promise rejection`. Hold at 0-1 events per 24h and 1-3 events per 7d. Escalate if the 7d count rises above 3 or a new title appears. Sentry org sentry, project docs, environment:production url:*/product/session-replay/mobile*
Client errors on url:*/product/session-replay* 1 event in the 24h window. 10 events in the 7d window: 9 of the same promise rejection, plus 1 TypeError: Cannot read properties of undefined (reading 'h6'). Hold at 0-2 events per 24h. Escalate if the 24h count rises above 2 or a new title appears on this path family. Sentry org sentry, project docs, environment:production url:*/product/session-replay*
docs.page.load on the two changed paths 24h: overview 6, performance 1. 7d: overview 108, performance 29. Hold near that mix. Escalate if either 24h count is 0 while /product/session-replay/ still loads. Sentry org sentry, project docs, metric.name:docs.page.load AND metric.type:counter AND environment:production grouped by path
Share of parent replay overview loads 24h: 6 of 25 parent loads. 7d: 108 of 460 parent loads. Share holds near 0.24. Hold the share in 0.20-0.28. Escalate if the share falls below 0.20 while parent loads continue. Same docs.page.load query for path:"/product/session-replay/mobile/" and path:"/product/session-replay/"
docs.page.not_found for requested_path:product/session-replay 0 in 2026-09-27T06:58:00Z to 2026-10-04T06:58:00Z. Hold at 0. Escalate if this counter leaves 0. Sentry org sentry, project docs, metric.name:docs.page.not_found AND metric.type:counter AND environment:production AND requested_path:product/session-replay

If the error count rises, check whether the new titles come from the two changed pages or from sibling replay pages.

Not observable

Sampled pageload and navigation spans for these URL paths returned no rows. Trace sample rate is 30 percent. Do not use span p95 or HTTP status from traces for this change. docs.mdx.compile_duration p95 was null in production. Pages are prebuilt, so that metric does not cover this ship. Web vitals for these two paths were not confirmed.

@coolguyzone
coolguyzone requested a review from markushi October 8, 2026 20:55
@sansynx

sansynx commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

the branch is up to date. could you approve the pending workflows and authorize the Vercel preview when you review this?

This branch has not been deployed

No deployments
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.

Clarify mobile replay frame rate is not configurable

2 participants