Skip to content

Commit a3ffb38

Browse files
authored
docs(unreal): add missing features to landing page and options (#16577)
1 parent 347ab93 commit a3ffb38

3 files changed

Lines changed: 52 additions & 3 deletions

File tree

docs/platforms/unreal/configuration/options.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,20 @@ This feature is supported only for Crashpad backend on Windows and Linux (defaul
167167

168168
</SdkOption>
169169

170+
<SdkOption name="EnableExternalCrashReporter" type="bool" defaultValue="false">
171+
172+
When enabled, a standalone crash reporter dialog is shown to the user after a crash, allowing them to review crash details and provide feedback before the report is submitted to Sentry.
173+
174+
See <PlatformLink to="/configuration/setup-crashreporter/#sentry-crash-reporter">Sentry Crash Reporter</PlatformLink> for setup details and customization options.
175+
176+
<Alert>
177+
178+
This feature is supported on Windows and Linux only.
179+
180+
</Alert>
181+
182+
</SdkOption>
183+
170184
## Hooks
171185

172186
These options can be used to hook the SDK in various ways to customize the reporting of events.
@@ -200,6 +214,38 @@ Currently, hints are supported only on Android.
200214

201215
</SdkOption>
202216

217+
## Offline Caching
218+
219+
<SdkOption name="EnableOfflineCaching" type="bool" defaultValue="false">
220+
221+
Enables persistent caching of envelopes to disk. When enabled, envelopes are stored in a cache directory and retained regardless of send success or failure. The cache is cleaned up on startup based on the limits configured below.
222+
223+
<Alert>
224+
225+
This feature is available on Windows, Linux, and Xbox only. On Android and Apple, caching is enabled by default.
226+
227+
</Alert>
228+
229+
</SdkOption>
230+
231+
<SdkOption name="CacheMaxItems" type="int" defaultValue="0">
232+
233+
Maximum number of items in the cache directory. On startup, oldest entries are removed until the count is within this limit. Set to `0` for no limit.
234+
235+
</SdkOption>
236+
237+
<SdkOption name="CacheMaxSize" type="int" defaultValue="0">
238+
239+
Maximum total size in bytes for the cache directory. On startup, oldest entries are removed until the size is within this limit. Set to `0` for no limit.
240+
241+
</SdkOption>
242+
243+
<SdkOption name="CacheMaxAge" type="int" defaultValue="0">
244+
245+
Maximum age in seconds for cache entries. On startup, entries exceeding this age are removed. Set to `0` for no limit.
246+
247+
</SdkOption>
248+
203249
## Tracing Options
204250

205251
<SdkOption name="TracesSampleRate" type="float">

docs/platforms/unreal/configuration/setup-crashreporter/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ to the user:
4141

4242
### Using the UE Crash Reporter on Windows
4343

44-
The UE Crash Reporter works if the Sentry SDK is installed. Sentry SDK can help with configuring the UE Crash Reporter, uploading debug symbols, and enriching crash reports with custom data. **Starting from UE 5.2** users have to choose between the two available crash capturing mechanisms - the UE Crash Reporter or the `sentry-native` library that's integrated into the Sentry plugin. By default, the `sentry-native` library is used instead of the UE Crash Reporter. (See "Enable automatic crash capturing (Windows, UE 5.2+)" in the plugin settings.) The two solutions are mutually exclusive and can't be used simultaneously.
44+
The UE Crash Reporter works if the Sentry SDK is installed. Sentry SDK can help with configuring the UE Crash Reporter, uploading debug symbols, and enriching crash reports with custom data. **Starting from UE 5.2** users have to choose between the two available crash capturing mechanisms - the UE Crash Reporter or the `sentry-native` library that's integrated into the Sentry plugin. By default, the `sentry-native` library is used instead of the UE Crash Reporter (see "Enable automatic crash capturing (Windows, UE 5.2+)" in the plugin settings). The two solutions are mutually exclusive and can't be used simultaneously.
4545

4646
## Sentry SDK and UE Crash Reporter feature comparison
4747

@@ -187,7 +187,7 @@ Available starting from Sentry Unreal SDK version 1.8.0. Supported on Windows an
187187

188188
Starting from version 1.8.0, the Sentry Unreal plugin ships with an optional **Sentry Crash Reporter** - a standalone application that can be used instead of the default UE Crash Reporter. When enabled, it displays a dialog to users after a crash, allowing them to review crash details and provide feedback before the report is submitted to Sentry.
189189

190-
Unlike the built-in UE Crash Reporter, the Sentry Crash Reporter works through the Sentry SDK pipeline and doesn't require modifying engine configuration files.
190+
Unlike the built-in UE Crash Reporter, the Sentry Crash Reporter works through the Sentry SDK pipeline and doesn't require modifying engine configuration files. This also means it requires Sentry's own crash capturing to be enabled (see "Enable automatic crash capturing (Windows, UE 5.2+)" in the plugin settings).
191191

192192
![Sentry Crash Reporter](./img/sentry-crash-reporter.png)
193193

docs/platforms/unreal/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea
2020
- macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++
2121
- iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++
2222
- Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++
23-
- Compatible with [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine
23+
- Compatible with default [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine
24+
- [Sentry Crash Reporter](/platforms/unreal/configuration/setup-crashreporter/#sentry-crash-reporter) dialog for collecting user feedback on crashes
2425
- [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) support
2526
- [Release health](/platforms/unreal/configuration/releases/) to keep track of crash free users and sessions
2627
- [Structured Logging](/platforms/unreal/logs/) to capture and send log messages with additional context
28+
- [Metrics](/platforms/unreal/metrics/) to track counters, gauges, and distributions
29+
- [Offline Caching](/platforms/unreal/configuration/options/#EnableOfflineCaching) stores event data to disk in case the device is not online
2730

2831
<Alert level="warning">
2932

0 commit comments

Comments
 (0)