Repository navigation
docs(unity): Document missing options and options configuration - #20414
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
bitsandfoxes
marked this pull request as ready for review
November 3, 2026 13:50
1 of 6 tasks
bitsandfoxes
force-pushed
the
fix/unity-docs-undocumented-options
branch
from
November 3, 2026 14:41
e88a649 to
f3fb942
Compare
JoshuaMoelans
approved these changes
Nov 13, 2026
bitsandfoxes
force-pushed
the
fix/unity-docs-undocumented-options
branch
from
November 13, 2026 16:05
612cca0 to
8320597
Compare
Add Options page entries for the Unity and inherited .NET options that the page lacks, grouped into filtering, logging and breadcrumbs, native support and metrics sections plus additions to the existing sections. Entries state both defaults where the configuration window differs from code and say when an option has no window field. On the Programmatic Configuration page, describe how the options configuration script is created, that Configure runs after the window values and during builds, and that WebGL initializes at BeforeSceneLoad. Replace the initialization flow image with a mermaid diagram. Name the native initialization type options on the Native Support page.
bitsandfoxes
force-pushed
the
fix/unity-docs-undocumented-options
branch
from
November 13, 2026 16:33
8320597 to
aef3a8f
Compare
bitsandfoxes
added a commit
that referenced
this pull request
Nov 13, 2026
## DESCRIBE YOUR PR Corrects the Unity native support and platform docs against the sentry-unity 4.13.0 source: which platforms get native crash reporting, what each one needs, and what reaches native crash reports. **Stacked on #20414**, which adds the option entries this PR links to. Its base is that branch, so the diff shows only this PR's changes. - **Supported Platforms** table on the Native Support page: native crashes, native SDK or backend, and requirements per platform, with the minimum Unity version, dedicated servers, the supported consoles and the platforms the SDK doesn't support. visionOS and UWP run on a best-effort basis. - Consoles report native crashes; the "work in progress" note is removed. - Android native support needs IL2CPP, and so does the default Cocoa backend on macOS; the experimental Native backend works with Mono. - **Scope Sync** section: what the SDK copies to the native SDKs, and what doesn't reach native crashes (custom contexts, attachments on iOS and macOS with Cocoa, the parts the app's SDK owns with Unity as a Library, and NDK scope sync turned off). The Attachments and Context pages link to it. - Windows: every file the build copies next to the player (`crashpad_handler.exe`, `crashpad_wer.dll`, `sentry-native.dll`; with the experimental Native backend `sentry-crash.exe`, `sentry-wer.dll`, `sentry-native.dll`), x64 and x86, and the experimental Native backend. macOS: the experimental Native backend. `NativeHandlerPath` and `DisableFileWrite`. - Game Consoles: Xbox needs `PersistentLocalStorage` in `MicrosoftGame.config`; Switch needs `TemporaryStorageSize` in the `.nmeta`, and runs without file writes, automatic session tracking or IL2CPP line numbers. - Minidumps: "Windows, Linux, and macOS with the Native backend" on the Native Support, Attachments and Store Minidumps pages. - iOS: `main.mm` and `SentryObjC.xcframework` in the native support and troubleshooting text. - Known limitations: why WebGL has no IL2CPP line numbers. The Unity quick start (`docs/platforms/unity/index.mdx`, open in #20012) names only `crashpad_handler.exe` as the file to ship with a Windows build; it needs the same three-file list. Pages to check on the preview: - `/platforms/unity/native-support/` - `/platforms/unity/game-consoles/` - `/platforms/unity/enriching-events/attachments/` - `/platforms/unity/enriching-events/context/` ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. Select exactly one option. For deadlines, replace `YYYY-MM-DD` with the due date. You can update this information later by editing the PR description. - [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD - [ ] Other deadline: YYYY-MM-DD - [x] No deadline: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've supplied a deadline. Thanks in advance for your help! ## PRE-MERGE CHECKLIST _Make sure you've checked the following before merging your changes:_ - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: JoshuaMoelans <60878493+JoshuaMoelans@users.noreply.github.com>
This branch was successfully deployed
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
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 Unity SDK options that the Unity docs don't list yet, and corrects the Programmatic Configuration page. Every type and default is read from the sentry-unity 4.13.0 source. Where the editor window's default differs from the code default, the entry gives both.
Stacked on #20413 (options page corrections): this PR's base is that branch, so the diff shows only this PR's changes. It moves to
masteronce #20413 merges.Enabled,CaptureInEditor,Throttler,AddBreadcrumbsForLogType, the per-platform native support switches, the native initialization types, the experimental desktop backends and the experimental metrics.SampleRate,CacheDirectoryPath,TracePropagationTargetsandIgnoreTransactions.DisableUnityLoggingIntegration(),DisableUnhandledExceptionCapture()and the exception-filter switches.IsEnvironmentUser, with its window default and its per-platform code default.FilterBadGatewayExceptions, which works from the window, an options configuration script andSentrySdk.Init.SentryOptionsConfiguration, and says thatConfigureruns after the window values and during player builds. The init-flow image is replaced by a mermaid diagram that shows where the native steps run, including WebGL'sBeforeSceneLoad.AndroidNativeInitializationTypeandIosNativeInitializationType.The configuration window itself isn't documented here; it explains itself, and screenshots go stale quickly.
Pages to check on the preview:
/platforms/unity/configuration/options//platforms/unity/configuration/options/programmatic-configuration/(the mermaid diagram)/platforms/unity/native-support/IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code