React Native UI profiling docs: now with information about iOS profiling#16260
React Native UI profiling docs: now with information about iOS profiling#16260
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| <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. |
There was a problem hiding this comment.
nit
| 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. |
antonis
left a comment
There was a problem hiding this comment.
Left a comment related to the iOS version and a nit suggestion. Other than that LGTM 🙇
antonis
left a comment
There was a problem hiding this comment.
LGTM 🚀
Let's wait for the release tomorrow and merge it
| profilingOptions: { | ||
| profileSessionSampleRate: 1.0, | ||
| lifecycle: 'trace', | ||
| lifecycle: "trace", | ||
| startOnAppStart: true, | ||
| }, |
There was a problem hiding this comment.
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.
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.