Skip to content

React Native UI profiling docs: now with information about iOS profiling#16260

Open
alwx wants to merge 2 commits intomasterfrom
alwx/docs/ui-profiling
Open

React Native UI profiling docs: now with information about iOS profiling#16260
alwx wants to merge 2 commits intomasterfrom
alwx/docs/ui-profiling

Conversation

@alwx
Copy link
Contributor

@alwx alwx commented Feb 4, 2026

The support for iOS UI profling was added to React Native SDK: getsentry/sentry-react-native#5611
Now it's time for the docs changes!

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+

@vercel
Copy link

vercel bot commented Feb 4, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Error Error Feb 4, 2026 2:19pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Feb 4, 2026 2:19pm

Request Review

<Alert>

Profiling for React Native is available in SDK versions `7.9.0` and above. Android is currently the only supported platform, and support is still experimental.
UI Profiling for React Native is available in SDK versions `7.9.0` and above. Android support was added in `7.9.0`, and iOS support was added in `7.10.0`. This feature is still experimental.
Copy link
Contributor

@antonis antonis Feb 4, 2026

Choose a reason for hiding this comment

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

nit

Suggested change
UI Profiling for React Native is available in SDK versions `7.9.0` and above. Android support was added in `7.9.0`, and iOS support was added in `7.10.0`. This feature is still experimental.
UI Profiling for React Native is available in SDK versions `7.9.0` and above on Android. iOS support was added in `7.12.0`. This feature is still experimental.

Copy link
Contributor

@antonis antonis left a comment

Choose a reason for hiding this comment

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

Left a comment related to the iOS version and a nit suggestion. Other than that LGTM 🙇

@codeowner-assignment codeowner-assignment bot requested a review from a team February 4, 2026 14:15
@alwx alwx requested a review from antonis February 4, 2026 14:16
Copy link
Contributor

@antonis antonis left a comment

Choose a reason for hiding this comment

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

LGTM 🚀
Let's wait for the release tomorrow and merge it

Comment on lines +86 to 90
profilingOptions: {
profileSessionSampleRate: 1.0,
lifecycle: 'trace',
lifecycle: "trace",
startOnAppStart: true,
},
Copy link

Choose a reason for hiding this comment

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

Bug: The documentation suggests startOnAppStart: true works for iOS, but this option is not supported by the native iOS SDK and will be silently ignored.
Severity: MEDIUM

Suggested Fix

Update the documentation to clarify that startOnAppStart is an Android-only option. Provide separate configuration examples or add a note explaining the platform-specific behavior within the unified example.

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/profiling/index.mdx#L86-L90

Potential issue: The documentation provides a unified `profilingOptions` configuration
example that includes `startOnAppStart: true`, implying it works for both Android and
iOS. However, this option is only supported on Android. The native iOS SDK for UI
profiling does not have an equivalent option. As a result, when developers use this
configuration for an iOS application, the `startOnAppStart` setting will be silently
ignored, and profiling will not begin on application launch as expected. This creates a
discrepancy where a documented feature fails to work on one of the supported platforms
without any warning or error.

Did we get this right? 👍 / 👎 to inform future reviews.

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