Skip to content

Commit 565a70d

Browse files
authored
godot(docs): Document App Hang options (#15330)
1 parent b62d2c5 commit 565a70d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/platforms/godot/configuration/options.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,24 @@ This option is turned off by default.
122122

123123
</SdkOption>
124124

125+
<SdkOption name="app_hang_tracking" type="bool" defaultValue="false">
126+
127+
If `true`, enables automatic detection and reporting of application hangs. The SDK will monitor the main thread and report hang events when it becomes unresponsive for longer than the duration specified in `app_hang_timeout_sec`. This helps identify performance issues where the application becomes frozen or unresponsive.
128+
129+
<Alert title="Note">
130+
131+
This feature is only supported on Android, iOS, and macOS platforms.
132+
133+
</Alert>
134+
135+
</SdkOption>
136+
137+
<SdkOption name="app_hang_timeout_sec" type="float" defaultValue="5.0">
138+
139+
Specifies the timeout duration in seconds after which the application is considered to have hanged. When `app_hang_tracking` is enabled, if the main thread is blocked for longer than this duration, it will be reported as an application hang event to Sentry.
140+
141+
</SdkOption>
142+
125143
## GUI-only Options
126144

127145
These options are only available in the **Project Settings** window.

0 commit comments

Comments
 (0)