Skip to content

docs(unity, native, unreal): Fix app hang docs - #20339

Merged
bitsandfoxes merged 2 commits into
masterfrom
feat/unity-docs-app-hangs
Oct 30, 2026
Merged

bitsandfoxes merged 2 commits into
masterfrom
feat/unity-docs-app-hangs

Conversation

@bitsandfoxes

@bitsandfoxes bitsandfoxes commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Fixes the app hang docs for Unity, sentry-native, and Unreal against the SDKs' current code. Consoles and Godot aren't covered here.

Unity

  • Mark app hang tracking as experimental and list the detector per platform, with requirements.
  • Explain how sentry-native detection works: a heartbeat from the Unity main thread once per second, the first frame excused, paused while the game is in the background or out of focus (feat: support for unity as a library on Android sentry-unity#2895), and why AppHangTimeout should stay at 2 seconds or more.
  • Describe the deprecated C# watchdog as editor-only, and add its MainThreadWatchdog query.
  • Add the missing redirect from /platforms/unity/configuration/app-not-responding/ to the app hangs page, and remove its orphaned image.

sentry-native

  • Document sentry_app_hang_pause() (0.16.1), and that only the watched thread may send heartbeats.
  • Detection starts with the first heartbeat, the watched thread stays until sentry_close(), each freeze is reported once, and events arrive up to 500 ms after the timeout.
  • Describe the event (level, message, AppHang exception and mechanism) and limits (no event without a stack trace, SIGRTMIN+4 on Linux and Android, Windows validated on x64).
  • Options page: 1000 ms minimum timeout and pause.
  • Android NDK page: requires sentry-android 8.49.0, not 8.48.0 (the 8.48.0 tag doesn't contain the feature), and pause requires 8.52.0.

Unreal

  • Engine watcher: reports threads that send engine heartbeats (game thread, async loading), and doesn't run in editor builds (including Standalone Game), Debug builds, with a debugger attached, or with -nothreadtimeout. Keep HangDuration above HangTimeoutDuration.
  • Native watchdog: heartbeat every frame, starts with the first frame, pauses in the background on Android only, also runs in the Editor; macOS needs the native backend.
  • Settings locations and labels, the two detectors' event names, and the CrashType:Hang tag.
  • Remove the version history about 1.13.0.

Should be merged together with the sentry-unity 4.12.0 release.

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
  • 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

🤖 Generated with Claude Code

Mark app hang tracking as experimental, list the detector per
platform, and explain the sentry-native heartbeat: the first frame is
excused, detection pauses in the background or out of focus
(getsentry/sentry-unity#2895), and timeouts below 2 seconds report
frame hitches.

Point readers to enable the deprecated watchdog only through the
editor, add its MainThreadWatchdog query, and redirect the removed
app-not-responding page to app hangs.
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 30, 2026 9:49am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 30, 2026 9:49am UTC

Request Review

sentry-native: document sentry_app_hang_pause(), that detection starts
with the first heartbeat and reports each freeze once, the event shape,
the 1 s minimum on the options page, and the stack capture limits. Fix
the Android NDK requirement to 8.49.0 and add pause (8.52.0).

Unreal: list the engine watcher's conditions (no Editor, Debug builds,
or debugger), that it reports any heartbeat thread, the native
watchdog's per-frame heartbeat with pause on Android only, its Editor
behavior, settings labels and event names; remove version history.

Unity: drop the console mention.
@bitsandfoxes bitsandfoxes changed the title docs(unity): Describe how app hang detection works docs(unity, native, unreal): Fix app hang docs Oct 30, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team, markushi and runningcode and removed request for a team October 30, 2026 09:41
@bitsandfoxes
bitsandfoxes marked this pull request as ready for review October 30, 2026 11:48
@codeowner-assignment
codeowner-assignment Bot requested review from a team October 30, 2026 11:48
@bitsandfoxes
bitsandfoxes merged commit d5a032a into master Oct 30, 2026
33 checks passed
@bitsandfoxes
bitsandfoxes deleted the feat/unity-docs-app-hangs branch October 30, 2026 14:15

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – sentry-docs — 30095298 Deployed Oct 30, 2026 by vercel[bot]
Preview – develop-docs — 4910f7da Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants