docs(dotnet): document .NET native options for Android and Apple#16664
docs(dotnet): document .NET native options for Android and Apple#16664jamescrosswell wants to merge 2 commits intocopilot-symlinkfrom
Conversation
Add dedicated reference pages for options.Native.* configuration on .NET for Android and .NET for Apple platforms (iOS, macOS, Mac Catalyst). - docs/platforms/dotnet/guides/android/configuration/native-options.mdx - docs/platforms/dotnet/guides/apple/configuration/native-options.mdx Covers: ANR detection, breadcrumbs, performance tracing, screenshots, app hangs, swizzling, session replay (experimental), error handling, NDK, networking, stack trace filtering, and profiling. Also updates the Android, Apple, and MAUI guide index pages to link to the new native options reference docs. Closes #11745 Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| @@ -0,0 +1 @@ | |||
| ../AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
suggestion: We may want to add this in a separate PR, as it's not .NET specific
|
|
||
| // All the native Android SDK options are available below | ||
| // https://docs.sentry.io/platforms/android/configuration/ | ||
| // Enable Native Android SDK ANR detection |
There was a problem hiding this comment.
question: intended to remove this comment?
| // https://docs.sentry.io/platforms/android/configuration/ | ||
| // Enable Native Android SDK ANR detection | ||
| // Native Android SDK options are available via options.Native | ||
| // See: /platforms/dotnet/guides/android/configuration/native-options/ |
There was a problem hiding this comment.
issue: this link is not quite helpful
Should this be https://docs.sentry.io/platforms/dotnet/guides/android/configuration/native-options/
docs/platforms/dotnet/guides/android/configuration/native-options.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| Adds breadcrumbs for `Activity` lifecycle events (created, started, resumed, paused, stopped, destroyed). | ||
|
|
||
| See [Automatic Breadcrumbs](/platforms/android/enriching-events/breadcrumbs/). |
There was a problem hiding this comment.
question: should we - for all Automatic Breadcrumbs links - link to the #automatic-breadcrumbs anchor ... but to be fair, that section is quite short and does not really give related information
|
|
||
| <SdkOption name="Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate" type="double?" defaultValue="null"> | ||
|
|
||
| Sample rate for sessions that encountered an error, between `0.0` and `1.0`. Set to `0.0` or leave as `null` to disable session replay for errored sessions. |
There was a problem hiding this comment.
question: errored
same comment as here: https://github.com/getsentry/sentry-docs/pull/16664/changes#r2886300004
|
|
||
| <SdkOption name="Native.ExperimentalOptions.SessionReplay.MaskAllText" type="bool" defaultValue="true"> | ||
|
|
||
| Masks all text content in session replay recordings to protect user privacy. Enabled by default. |
There was a problem hiding this comment.
todo: we need to mention "best effort" when it comes to automatic masking
|
|
||
| <SdkOption name="Native.ExperimentalOptions.SessionReplay.MaskAllImages" type="bool" defaultValue="true"> | ||
|
|
||
| Masks all images in session replay recordings to protect user privacy. Enabled by default. |
There was a problem hiding this comment.
todo: we need to mention "best effort" when it comes to automatic masking
docs/platforms/dotnet/guides/apple/configuration/native-options.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| <SdkOption name="Native.ExperimentalOptions.SessionReplay.EnableSessionReplayInUnreliableEnvironment" type="bool" defaultValue="false"> | ||
|
|
||
| Forces session replay to be enabled even in unreliable environments (iOS 26+ with Liquid Glass). By default, session replay is disabled on iOS 26 and later because masking of text and images cannot be reliably guaranteed. |
There was a problem hiding this comment.
thought: I'm not sure we should every write reliably guaranteed when it comes to automatic masking
See also the first warning of https://docs.sentry.io/platforms/apple/guides/ios/session-replay/.
We shouldn't imply that - even without Liquid Glass - automatic masking can be "guaranteed".
Not sure how to rephrase it, though 🙁
docs/platforms/dotnet/guides/android/configuration/native-options.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/dotnet/guides/apple/configuration/native-options.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/dotnet/guides/apple/configuration/native-options.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Stefan Pölz <38893694+Flash0ver@users.noreply.github.com>
DESCRIBE YOUR PR
Documents the options.Native.* configuration surface for the embedded native SDKs in .NET for Android and .NET for Apple.
Previously these options were undocumented. This adds dedicated reference pages for both platforms.
Changes:
Closes #11745
Based on #16663
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST