Skip to content

docs(dotnet): document .NET native options for Android and Apple#16664

Open
jamescrosswell wants to merge 2 commits intocopilot-symlinkfrom
native-options
Open

docs(dotnet): document .NET native options for Android and Apple#16664
jamescrosswell wants to merge 2 commits intocopilot-symlinkfrom
native-options

Conversation

@jamescrosswell
Copy link
Collaborator

@jamescrosswell jamescrosswell commented Mar 4, 2026

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:

  • New: docs/platforms/dotnet/guides/android/configuration/native-options.mdx
  • New: docs/platforms/dotnet/guides/apple/configuration/native-options.mdx
  • Updated: Android, Apple, and MAUI guide index pages to link to the new docs

Closes #11745
Based on #16663

IS YOUR CHANGE URGENT?

  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

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>
@vercel
Copy link

vercel bot commented Mar 4, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 5, 2026 2:20am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Mar 5, 2026 2:20am

Request Review

@codeowner-assignment codeowner-assignment bot requested a review from a team March 4, 2026 01:06
@@ -0,0 +1 @@
../AGENTS.md No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

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/
Copy link
Member

Choose a reason for hiding this comment

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

issue: this link is not quite helpful

Should this be https://docs.sentry.io/platforms/dotnet/guides/android/configuration/native-options/


Adds breadcrumbs for `Activity` lifecycle events (created, started, resumed, paused, stopped, destroyed).

See [Automatic Breadcrumbs](/platforms/android/enriching-events/breadcrumbs/).
Copy link
Member

Choose a reason for hiding this comment

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

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.
Copy link
Member

Choose a reason for hiding this comment

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


<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.
Copy link
Member

Choose a reason for hiding this comment

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

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.
Copy link
Member

Choose a reason for hiding this comment

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

todo: we need to mention "best effort" when it comes to automatic masking


<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.
Copy link
Member

Choose a reason for hiding this comment

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

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 🙁

Co-authored-by: Stefan Pölz <38893694+Flash0ver@users.noreply.github.com>
@codeowner-assignment codeowner-assignment bot requested a review from a team March 5, 2026 02:09
@jamescrosswell jamescrosswell changed the base branch from master to copilot-symlink March 5, 2026 03:30
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.

Document .NET mobile support

2 participants