diff --git a/develop-docs/sdk/foundations/transport/authentication.mdx b/develop-docs/sdk/foundations/transport/authentication.mdx index 475647e124ba0b..b4c1dbb63f9aa2 100644 --- a/develop-docs/sdk/foundations/transport/authentication.mdx +++ b/develop-docs/sdk/foundations/transport/authentication.mdx @@ -30,7 +30,7 @@ Sentry provides the following endpoints: - [/envelope/](../envelopes/) for any submission using Envelopes. - [`/minidump/`](https://docs.sentry.io/platforms/native/minidump/) for multipart requests containing Minidumps. -- [`/unreal/`](https://docs.sentry.io/platforms/unreal/configuration/setup-crashreporter/) for Unreal +- [`/unreal/`](https://docs.sentry.io/platforms/unreal/configuration/crash-reporter/crash-reporter-client/) for Unreal Engine 4 crash reports. - [`/playstation/`](https://docs.sentry.io/platforms/playstation/) for PlayStation crash reports. diff --git a/docs/platforms/unreal/configuration/app-hangs/index.mdx b/docs/platforms/unreal/configuration/app-hangs/index.mdx index ce9a14b625da1f..ab86271b5e0c8d 100644 --- a/docs/platforms/unreal/configuration/app-hangs/index.mdx +++ b/docs/platforms/unreal/configuration/app-hangs/index.mdx @@ -40,7 +40,7 @@ The engine's heartbeat monitor thread must be enabled for hang tracking to work. HangDuration=25 ``` -`HangDuration` is the threshold (in seconds) after which the engine reports a hang to the [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/). The Sentry SDK's hang tracking coexists with the engine's mechanism — the SDK hooks into the heartbeat system independently and captures its own events based on the hang timeout you configure. +`HangDuration` is the threshold (in seconds) after which the engine reports a hang to the [Crash Reporter Client](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/). The Sentry SDK's hang tracking coexists with the engine's mechanism — the SDK hooks into the heartbeat system independently and captures its own events based on the hang timeout you configure. ## Configuration diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/img/ue-crash-reporter-settings.png b/docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-crash-reporter-settings.png similarity index 100% rename from docs/platforms/unreal/configuration/setup-crashreporter/img/ue-crash-reporter-settings.png rename to docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-crash-reporter-settings.png diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/img/ue-crash-reporter.png b/docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-crash-reporter.png similarity index 100% rename from docs/platforms/unreal/configuration/setup-crashreporter/img/ue-crash-reporter.png rename to docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-crash-reporter.png diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/img/ue-include-crash-reporter.png b/docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-include-crash-reporter.png similarity index 100% rename from docs/platforms/unreal/configuration/setup-crashreporter/img/ue-include-crash-reporter.png rename to docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/img/ue-include-crash-reporter.png diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx b/docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/index.mdx similarity index 60% rename from docs/platforms/unreal/configuration/setup-crashreporter/index.mdx rename to docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/index.mdx index 546fe9b9ea3dfc..8a5faa77876bf1 100644 --- a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx +++ b/docs/platforms/unreal/configuration/crash-reporter/crash-reporter-client/index.mdx @@ -1,6 +1,7 @@ --- title: Crash Reporter Client -description: Learn about Sentry's Unreal Engine integration with Crash Reporter Client. +sidebar_order: 2 +description: Learn about Sentry's Unreal Engine integration with the Crash Reporter Client. og_image: /og-images/platforms-unreal-configuration-setup-crashreporter.png --- @@ -9,7 +10,7 @@ Unreal Engine application or game, because Sentry supports the _UE Crash Reporte -Starting from SDK version 1.8.0, the Sentry plugin includes its own [Sentry Crash Reporter](#sentry-crash-reporter) - an alternative to the built-in UE Crash Reporter that works through the Sentry SDK pipeline and supports user feedback. +The Sentry Unreal plugin also ships with its own [Sentry Crash Reporter](../sentry-crash-reporter/) - a standalone alternative to the UE Crash Reporter that integrates directly with the Sentry SDK pipeline and supports user feedback. If you're choosing between the two, we recommend starting with the Sentry Crash Reporter. @@ -177,116 +178,6 @@ add JSON support to the build script (`MyProject.build.cs`): PublicDependencyModuleNames.AddRange(new string[] { ..., "Json" }); ``` -## Sentry Crash Reporter - - - -Available starting from Sentry Unreal SDK version 1.8.0. Supported on Windows and Linux only. - - - -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. - -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). - -![Sentry Crash Reporter](./img/sentry-crash-reporter.png) - -### Enabling the Sentry Crash Reporter - -To enable it, navigate to **Project Settings > Plugins > Sentry > General > Native** and toggle **Enable external crash reporter**. - -Alternatively, add the following to your project's configuration `.ini` file: - -```ini -[/Script/Sentry.SentrySettings] -EnableExternalCrashReporter=True -``` - -### Customizing the Crash Reporter - -You can customize the appearance of the Sentry Crash Reporter directly from the plugin settings. Navigate to **Project Settings > Plugins > Sentry > General > Native** and expand the **External crash reporter appearance** section. Each property has an override toggle - only properties you explicitly enable will be applied: - -- **Window title** - Custom title for the crash reporter window. -- **Header text** - Header text shown in the crash reporter dialog. -- **Header description** - Description text shown below the header. Leave empty to hide. -- **Submit button label** - Label for the submit/send button. -- **Cancel button label** - Label for the cancel button. Set to empty string to hide the button. -- **Accent color** - Primary accent color used for the crash reporter UI elements. -- **Window closable** - When disabled, the user cannot close the crash reporter window without submitting the report. The native close button is disabled and the cancel button is hidden. Enabled by default. - -These settings are applied each time the SDK initializes. Properties that are not overridden will use the crash reporter's built-in defaults. - -#### Using a Custom Crash Reporter Build - -For more advanced customization (such as custom logos or layout changes), you can fork the [sentry-desktop-crash-reporter](https://github.com/getsentry/sentry-desktop-crash-reporter) project and build a custom version. - -To build on Windows: - -```powershell -cd sentry-desktop-crash-reporter -dotnet publish -f net9.0-desktop -r win-x64 Sentry.CrashReporter/Sentry.CrashReporter.csproj -o build-output -``` - -For other platforms, replace the runtime identifier with `win-arm64`, `linux-x64`, or `linux-arm64`. - -Copy the output executable into the plugin's ThirdParty binaries directory: - -- **Windows**: `Plugins/sentry-unreal/Source/ThirdParty/Win64/bin/Sentry.CrashReporter.exe` -- **Linux**: `Plugins/sentry-unreal/Source/ThirdParty/Linux/bin/Sentry.CrashReporter` - -After replacing the executable, delete the project's `Build` and `Intermediate` directories and rebuild to ensure the updated binary is picked up. - -Refer to the project's [customization guide](https://github.com/getsentry/sentry-desktop-crash-reporter/blob/main/CUSTOMIZATION.md) for details on what can be changed. - -### Stacktrace Display - -The Sentry Crash Reporter can display a symbolicated stacktrace of the crashed thread, allowing users to review the call stack directly in the crash dialog before submitting the report. - -This feature requires client-side stack walking, which is supported through two backend configurations: - -- **[Native backend](/platforms/unreal/configuration/native-backend/)**: Performs stack walking and symbolication automatically using the platform's debug APIs. No additional configuration is needed. -- **Crashpad backend**: Requires a custom build of `sentry-native` with the `CRASHPAD_ENABLE_STACKTRACE` CMake flag enabled. See [below](#building-sentry-native-with-stacktrace-support) for instructions. - - - -For **Shipping builds**, the stacktrace can only be symbolicated if debug information is available at runtime. Enable **Include Debug Files in Shipping Builds** in **Project Settings > Packaging** to ensure function names are resolved in the crash reporter dialog. - - - -#### Building sentry-native With Stacktrace Support - -To enable client-side stacktrace display when using the Crashpad backend, you need to rebuild `sentry-native` with the `CRASHPAD_ENABLE_STACKTRACE` CMake flag. The example below shows a Windows build — for other platforms, refer to the [sentry-native build documentation](https://github.com/getsentry/sentry-native#build-and-installation) and the [CI build scripts](https://github.com/getsentry/sentry-unreal/tree/main/scripts) in the sentry-unreal repository. - -Clone [sentry-native](https://github.com/getsentry/sentry-native) and check out the version that matches your plugin (pinned under `modules/sentry-native` in the [sentry-unreal](https://github.com/getsentry/sentry-unreal) repository). Then build: - -```powershell -cd D:\projects\sentry-native - -cmake -G "Visual Studio 17 2022" -S . -B build ` - -D SENTRY_BACKEND=crashpad ` - -D SENTRY_SDK_NAME=sentry.native.unreal ` - -D SENTRY_BUILD_SHARED_LIBS=OFF ` - -D CRASHPAD_ENABLE_STACKTRACE=ON - -cmake --build build --target sentry --config RelWithDebInfo --parallel -cmake --build build --target crashpad_handler --config RelWithDebInfo --parallel -cmake --install build --prefix install --config RelWithDebInfo -``` - -Copy the build output into your project's plugin directory: - -- `install/lib/*` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/lib/` -- `install/bin/crashpad_handler.exe` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/bin/` -- `install/include/sentry.h` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/include/` - -After replacing binaries, delete your project's `Build` and `Intermediate` directories and rebuild. - - - -The `CRASHPAD_ENABLE_STACKTRACE` feature is experimental. On Linux, it requires the `libunwind-ptrace` development package. - - - ## Upload Debug Symbols To allow Sentry to fully process native crashes and provide you with diff --git a/docs/platforms/unreal/configuration/crash-reporter/index.mdx b/docs/platforms/unreal/configuration/crash-reporter/index.mdx new file mode 100644 index 00000000000000..e10854e8f215c4 --- /dev/null +++ b/docs/platforms/unreal/configuration/crash-reporter/index.mdx @@ -0,0 +1,11 @@ +--- +title: Crash Reporter +description: "Learn about the crash reporters supported by the Sentry Unreal SDK." +next_steps: + - sentry-crash-reporter + - crash-reporter-client +--- + +The Sentry Unreal plugin supports two crash reporter options — pick whichever fits your workflow. + + diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/img/sentry-crash-reporter.png b/docs/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/img/sentry-crash-reporter.png similarity index 100% rename from docs/platforms/unreal/configuration/setup-crashreporter/img/sentry-crash-reporter.png rename to docs/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/img/sentry-crash-reporter.png diff --git a/docs/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/index.mdx b/docs/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/index.mdx new file mode 100644 index 00000000000000..127a911fda22ed --- /dev/null +++ b/docs/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/index.mdx @@ -0,0 +1,116 @@ +--- +title: Sentry Crash Reporter +sidebar_order: 1 +description: Learn about the standalone Sentry Crash Reporter shipped with the Sentry Unreal plugin. +--- + + + +Available starting from Sentry Unreal SDK version 1.8.0. Supported on all desktop platforms — on macOS the [native crash backend](/platforms/unreal/configuration/native-backend/) must be enabled. + + + +The Sentry Unreal plugin ships with an optional **Sentry Crash Reporter** — a standalone application that can be used instead of the default [Crash Reporter Client](../crash-reporter-client/). 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. + +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). + +![Sentry Crash Reporter](./img/sentry-crash-reporter.png) + +## Enabling the Sentry Crash Reporter + +To enable it, navigate to **Project Settings > Plugins > Sentry > Sentry Crash Reporter** and toggle **Enable Sentry Crash Reporter**. + +Alternatively, add the following to your project's configuration `.ini` file: + +```ini +[/Script/Sentry.SentrySettings] +EnableExternalCrashReporter=True +``` + +## Customizing the Crash Reporter + +You can customize the appearance of the Sentry Crash Reporter directly from the plugin settings. Navigate to **Project Settings > Plugins > Sentry > Sentry Crash Reporter** and expand the **Sentry Crash Reporter appearance** section. Each property has an override toggle — only properties you explicitly enable will be applied: + +- **Window title** - Custom title for the crash reporter window. +- **Header text** - Header text shown in the crash reporter dialog. +- **Header description** - Description text shown below the header. Leave empty to hide. +- **Submit button label** - Label for the submit/send button. +- **Cancel button label** - Label for the cancel button. Set to empty string to hide the button. +- **Accent color** - Primary accent color used for the crash reporter UI elements. +- **Window closable** - When disabled, the user cannot close the crash reporter window without submitting the report. The native close button is disabled and the cancel button is hidden. Enabled by default. + +These settings are applied each time the SDK initializes. Properties that are not overridden will use the crash reporter's built-in defaults. + +### Using a Custom Crash Reporter Build + +For more advanced customization (such as custom logos or layout changes), you can fork the [sentry-desktop-crash-reporter](https://github.com/getsentry/sentry-desktop-crash-reporter) project and build a custom version. + +To build on Windows: + +```powershell +cd sentry-desktop-crash-reporter +dotnet publish -f net9.0-desktop -r win-x64 Sentry.CrashReporter/Sentry.CrashReporter.csproj -o build-output +``` + +For other platforms, replace the runtime identifier with `win-arm64`, `linux-x64`, `linux-arm64`, or `osx-arm64`. + +Copy the output executable into the plugin's ThirdParty binaries directory: + +- **Windows (x64)**: `Plugins/sentry-unreal/Source/ThirdParty/Win64/Sentry.CrashReporter.exe` +- **Windows (ARM64)**: `Plugins/sentry-unreal/Source/ThirdParty/WinArm64/Sentry.CrashReporter.exe` +- **Linux (x64)**: `Plugins/sentry-unreal/Source/ThirdParty/Linux/Sentry.CrashReporter` +- **Linux (ARM64)**: `Plugins/sentry-unreal/Source/ThirdParty/LinuxArm64/Sentry.CrashReporter` +- **macOS**: `Plugins/sentry-unreal/Source/ThirdParty/Mac/Sentry.CrashReporter` + +After replacing the executable, delete the project's `Build` and `Intermediate` directories and rebuild to ensure the updated binary is picked up. + +Refer to the project's [customization guide](https://github.com/getsentry/sentry-desktop-crash-reporter/blob/main/CUSTOMIZATION.md) for details on what can be changed. + +## Stacktrace Display + +The Sentry Crash Reporter can display a symbolicated stacktrace of the crashed thread, allowing users to review the call stack directly in the crash dialog before submitting the report. + +This feature requires client-side stack walking, which is supported through two backend configurations: + +- **[Native backend](/platforms/unreal/configuration/native-backend/)**: Performs stack walking and symbolication automatically using the platform's debug APIs. No additional configuration is needed. +- **Crashpad backend**: Requires a custom build of `sentry-native` with the `CRASHPAD_ENABLE_STACKTRACE` CMake flag enabled. See [below](#building-sentry-native-with-stacktrace-support) for instructions. + + + +For **Shipping builds**, the stacktrace can only be symbolicated if debug information is available at runtime. Enable **Include Debug Files in Shipping Builds** in **Project Settings > Packaging** to ensure function names are resolved in the crash reporter dialog. + + + +### Building sentry-native With Stacktrace Support + +To enable client-side stacktrace display when using the Crashpad backend, you need to rebuild `sentry-native` with the `CRASHPAD_ENABLE_STACKTRACE` CMake flag. The example below shows a Windows build — for other platforms, refer to the [sentry-native build documentation](https://github.com/getsentry/sentry-native#build-and-installation) and the [CI build scripts](https://github.com/getsentry/sentry-unreal/tree/main/scripts) in the sentry-unreal repository. + +Clone [sentry-native](https://github.com/getsentry/sentry-native) and check out the version that matches your plugin (pinned under `modules/sentry-native` in the [sentry-unreal](https://github.com/getsentry/sentry-unreal) repository). Then build: + +```powershell +cd D:\projects\sentry-native + +cmake -G "Visual Studio 17 2022" -S . -B build ` + -D SENTRY_BACKEND=crashpad ` + -D SENTRY_SDK_NAME=sentry.native.unreal ` + -D SENTRY_BUILD_SHARED_LIBS=OFF ` + -D CRASHPAD_ENABLE_STACKTRACE=ON + +cmake --build build --target sentry --config RelWithDebInfo --parallel +cmake --build build --target crashpad_handler --config RelWithDebInfo --parallel +cmake --install build --prefix install --config RelWithDebInfo +``` + +Copy the build output into your project's plugin directory: + +- `install/lib/*` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/lib/` +- `install/bin/crashpad_handler.exe` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/bin/` +- `install/include/sentry.h` → `Plugins/sentry-unreal/Source/ThirdParty/Win64/Crashpad/include/` + +After replacing binaries, delete your project's `Build` and `Intermediate` directories and rebuild. + + + +The `CRASHPAD_ENABLE_STACKTRACE` feature is experimental. On Linux, it requires the `libunwind-ptrace` development package. + + diff --git a/docs/platforms/unreal/configuration/options.mdx b/docs/platforms/unreal/configuration/options.mdx index 25d38b9e42d7a6..121dc3d4a19ffa 100644 --- a/docs/platforms/unreal/configuration/options.mdx +++ b/docs/platforms/unreal/configuration/options.mdx @@ -199,7 +199,7 @@ This feature is supported only for Crashpad backend on Windows and Linux (defaul 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. -See Sentry Crash Reporter for setup details and customization options. +See Sentry Crash Reporter for setup details and customization options. diff --git a/docs/platforms/unreal/enriching-events/context/index.mdx b/docs/platforms/unreal/enriching-events/context/index.mdx index fc0272afaa555f..d578a1bab0e817 100644 --- a/docs/platforms/unreal/enriching-events/context/index.mdx +++ b/docs/platforms/unreal/enriching-events/context/index.mdx @@ -36,7 +36,7 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set context](./unreal_set_context.png) -Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). +Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes). diff --git a/docs/platforms/unreal/enriching-events/identify-user/index.mdx b/docs/platforms/unreal/enriching-events/identify-user/index.mdx index a8b5b7cb07c79c..b964978046d9f8 100644 --- a/docs/platforms/unreal/enriching-events/identify-user/index.mdx +++ b/docs/platforms/unreal/enriching-events/identify-user/index.mdx @@ -60,7 +60,7 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set user](./img/unreal_set_user.png) -Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). +Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes). You can also clear the currently set user: @@ -74,4 +74,4 @@ Or in blueprint: ![Unset user](./img/unreal_unset_user.png) -In configurations with a crash reporter, create a new `__sentry` config object without the `user` field. Then, call `FGenericCrashContext::SetGameData` from the [initialization function](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes) with the new JSON data. You have to provide all other fields again, as the call overrides the previously registered data. +In configurations with a crash reporter, create a new `__sentry` config object without the `user` field. Then, call `FGenericCrashContext::SetGameData` from the [initialization function](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes) with the new JSON data. You have to provide all other fields again, as the call overrides the previously registered data. diff --git a/docs/platforms/unreal/index.mdx b/docs/platforms/unreal/index.mdx index 34569a0d754be3..c28ac3ebdb1d8b 100644 --- a/docs/platforms/unreal/index.mdx +++ b/docs/platforms/unreal/index.mdx @@ -21,8 +21,9 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea - macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++ - iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++ - Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++ -- Compatible with default [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine -- [Sentry Crash Reporter](/platforms/unreal/configuration/setup-crashreporter/#sentry-crash-reporter) dialog for collecting user feedback on crashes +- [Crash Reporter](/platforms/unreal/configuration/crash-reporter/) support + - [Sentry Crash Reporter](/platforms/unreal/configuration/crash-reporter/sentry-crash-reporter/) - standalone app for collecting user feedback after a crash + - Compatibility with the default [Crash Reporter Client](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/) provided along with Unreal Engine - [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) support - [Release health](/platforms/unreal/configuration/releases/) to keep track of crash free users and sessions - [Structured Logging](/platforms/unreal/logs/) to capture and send log messages with additional context @@ -31,7 +32,7 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea -To automatically capture crashes on Windows with UE 5.1 or older, you have to configure the [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/). Starting from UE 5.2, the provided API allows you to switch between default (CRC) and third-party (Sentry) crash-handling solutions, so the CRC configuration step isn't required. The two are mutually exclusive and can't be used simultaneously. +To automatically capture crashes on Windows with UE 5.1 or older, you have to configure the [Crash Reporter Client](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/). Starting from UE 5.2, the provided API allows you to switch between default (CRC) and third-party (Sentry) crash-handling solutions, so the CRC configuration step isn't required. The two are mutually exclusive and can't be used simultaneously. diff --git a/middleware.ts b/middleware.ts index a2eb5c4e69643f..8daaf51ecf47f1 100644 --- a/middleware.ts +++ b/middleware.ts @@ -1230,11 +1230,15 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/platforms/unreal/setup-crashreport/', - to: '/platforms/unreal/configuration/setup-crashreporter/', + to: '/platforms/unreal/configuration/crash-reporter/crash-reporter-client/', }, { from: '/platforms/unreal/setup-crashreporter/', - to: '/platforms/unreal/configuration/setup-crashreporter/', + to: '/platforms/unreal/configuration/crash-reporter/crash-reporter-client/', + }, + { + from: '/platforms/unreal/configuration/setup-crashreporter/', + to: '/platforms/unreal/configuration/crash-reporter/crash-reporter-client/', }, { from: '/platforms/unreal/debug-symbols/', diff --git a/platform-includes/enriching-events/set-context/unreal.mdx b/platform-includes/enriching-events/set-context/unreal.mdx index 60389de60cf216..2151743ff84d54 100644 --- a/platform-includes/enriching-events/set-context/unreal.mdx +++ b/platform-includes/enriching-events/set-context/unreal.mdx @@ -12,4 +12,4 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set context](./img/unreal_set_context.png) -Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). +Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes). diff --git a/platform-includes/enriching-events/set-tag/unreal.mdx b/platform-includes/enriching-events/set-tag/unreal.mdx index 8fd82886aeee3a..b9b2f11c39815f 100644 --- a/platform-includes/enriching-events/set-tag/unreal.mdx +++ b/platform-includes/enriching-events/set-tag/unreal.mdx @@ -8,7 +8,7 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set tag](./img/unreal_set_tag.png) -Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). +Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes). Commonly used values including `Engine version`, `Configuration`, and `Target Type`, can be promoted to tags via Sentry's configuration window by navigating to the editor's menu **Project Settings > Plugins > Sentry > Misc > Promote values to tags** and selecting the values that should be automatically added to captured events as tags. diff --git a/platform-includes/enriching-events/set-user/unreal.mdx b/platform-includes/enriching-events/set-user/unreal.mdx index ec72462dc67f48..8742c2e5545600 100644 --- a/platform-includes/enriching-events/set-user/unreal.mdx +++ b/platform-includes/enriching-events/set-user/unreal.mdx @@ -19,4 +19,4 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set user](./img/unreal_set_user.png) -Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). +Alternatively, this configuration can be provided to the crash reporter [during initialization](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes). diff --git a/platform-includes/enriching-events/unset-user/unreal.mdx b/platform-includes/enriching-events/unset-user/unreal.mdx index 73cc4a15f72587..f737f741eaadf9 100644 --- a/platform-includes/enriching-events/unset-user/unreal.mdx +++ b/platform-includes/enriching-events/unset-user/unreal.mdx @@ -8,4 +8,4 @@ Or in blueprint: ![Unset user](./img/unreal_unset_user.png) -In configurations with a crash reporter, create a new `__sentry` config object without the `user` field. Then, call `FGenericCrashContext::SetGameData` from the [initialization function](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes) with the new JSON data. You have to provide all other fields again, as the call overrides the previously registered data. +In configurations with a crash reporter, create a new `__sentry` config object without the `user` field. Then, call `FGenericCrashContext::SetGameData` from the [initialization function](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/#configure-the-crash-reporter-attributes) with the new JSON data. You have to provide all other fields again, as the call overrides the previously registered data. diff --git a/platform-includes/getting-started-primer/unreal.mdx b/platform-includes/getting-started-primer/unreal.mdx index e5ad4d08a7afc8..36ad1d6591d549 100644 --- a/platform-includes/getting-started-primer/unreal.mdx +++ b/platform-includes/getting-started-primer/unreal.mdx @@ -7,11 +7,11 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea - iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++ - Windows (UE 5.2+) and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps - macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++ -- Compatible with [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine +- Compatible with [Crash Reporter Client](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/) provided along with Unreal Engine - [Release health](/platforms/unreal/configuration/releases/) to keep track of crash free users and sessions -To automatically capture crashes on Windows with UE 5.1 or older, you have to configure the [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/). Starting from UE 5.2, the provided API allows you to switch between default (CRC) and third-party (Sentry) crash-handling solutions, so the CRC configuration step isn't required. The two are mutually exclusive and can't be used simultaneously. +To automatically capture crashes on Windows with UE 5.1 or older, you have to configure the [Crash Reporter Client](/platforms/unreal/configuration/crash-reporter/crash-reporter-client/). Starting from UE 5.2, the provided API allows you to switch between default (CRC) and third-party (Sentry) crash-handling solutions, so the CRC configuration step isn't required. The two are mutually exclusive and can't be used simultaneously.