docs(dotnet): document .NET native options for Android and Apple#16664
Open
jamescrosswell wants to merge 2 commits intomasterfrom
Open
docs(dotnet): document .NET native options for Android and Apple#16664jamescrosswell wants to merge 2 commits intomasterfrom
jamescrosswell wants to merge 2 commits intomasterfrom
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
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+1
to
+10
| --- | ||
| title: Apple Native Options | ||
| description: "Configure the embedded Sentry Cocoa SDK when using .NET for iOS, macOS, or Mac Catalyst." | ||
| sidebar_order: 10 | ||
| --- | ||
|
|
||
| When you use the .NET for Apple platforms integration, Sentry embeds the [Sentry Cocoa SDK](/platforms/apple/) to provide native crash reporting and other platform-specific features. The `options.Native` property exposes configuration for this embedded SDK. | ||
|
|
||
| ```csharp | ||
| SentrySdk.Init(options => |
There was a problem hiding this comment.
Bug: The documentation for Native.EnableAppHangTracking incorrectly lists its default value as false, while the underlying Cocoa SDK defaults it to true, potentially misleading developers.
Severity: HIGH
Suggested Fix
In the docs/platforms/dotnet/guides/apple/configuration/native-options.mdx file, change the documented defaultValue for the Native.EnableAppHangTracking option from "false" to "true" to match the actual default behavior of the Sentry Cocoa SDK.
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/dotnet/guides/apple/configuration/native-options.mdx#L1-L10
Potential issue: The documentation for Apple native options in `native-options.mdx`
incorrectly states that the `defaultValue` for `Native.EnableAppHangTracking` is
`false`. This contradicts the behavior of the underlying Sentry Cocoa SDK, which enables
this feature by default in versions 8.0.0 and later. This discrepancy can mislead
developers into thinking the feature is off by default. A developer might then
explicitly set the option to `false` to disable what they believe is an inactive
feature, inadvertently turning off an important, enabled-by-default monitoring
capability and leading to a loss of app hang event data.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST