docs(unity): document native Windows crash reporting and WER - #327
Open
bobbyg603 wants to merge 1 commit into
Open
docs(unity): document native Windows crash reporting and WER#327bobbyg603 wants to merge 1 commit into
bobbyg603 wants to merge 1 commit into
Conversation
The Unity page still described uploading minidumps written by the UnityCrashHandler via PostAllCrashes. bugsplat-unity 5.0.0 replaces that flow entirely with native capture, so the page documented an API that no longer exists. Adds a Windows platform section matching the Android, iOS and macOS ones, covering native crash reporting on both scripting backends, the support files installers must ship, Windows Error Reporting, and hang detection. The WER part is the piece with no prior documentation anywhere: fail-fast crashes bypass the crash handler entirely and are only captured when BugSplatWer.dll is registered under RuntimeExceptionHelperModules, which is an installer responsibility and fails silently when missed. Also adds the three Windows options to the options table and repoints the stale "upload windows minidumps" link in the overview. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Summary
Documents the Windows work landing in bugsplat-unity#123 (5.0.0).
The Unity page currently tells people to upload minidumps written by the
UnityCrashHandlerand to callPostAllCrashes()at launch. 5.0.0 replaces that flow with native capture and removes those methods, so the page documents an API that no longer exists.Changes
New
🪟 Windowssection, matching the shape of the existing Android/iOS/macOS ones — native crash reporting on both Mono and IL2CPP (Windows is the only platform where Mono works), x86/x64/ARM64, the support files installers must ship, and the VC++ redistributable note.Windows Error Reporting — the part with no documentation anywhere today. Fail-fast crashes (stack buffer overrun
0xC0000409, heap corruption0xC0000374,__fastfail) bypass every in-process handler, so they're only captured whenBugSplatWer.dllis registered underRuntimeExceptionHelperModules. That registration is an installer responsibility, requires admin, and fails silently when missed. Covers the registry snippets for install and uninstall, the editor menu item for local builds,WindowsWerEnabledfor runtime detection, and the endpoint-protection gotcha.Windows hang detection, including why it defaults to disabled — a false positive terminates the player.
Minidump section rewritten to point at the new section and explain what replaced the removed methods.
Also adds the three Windows options to the options table and repoints the stale "upload windows minidumps" link in the overview.
Merge timing
Hold until bugsplat-unity 5.0.0 ships — this documents behavior that isn't released yet. Same pattern as #160.
🤖 Generated with Claude Code