From fb2e5d512f0ec29607e2262f1ac2a4a52c380287 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 9 Aug 2023 10:45:33 +0300 Subject: [PATCH 01/14] Update Getting Started guide --- .../getting-started-config/unreal.mdx | 2 +- .../getting-started-install/unreal.mdx | 2 +- .../getting-started-primer/unreal.mdx | 15 ++++----------- 3 files changed, 6 insertions(+), 13 deletions(-) diff --git a/src/platform-includes/getting-started-config/unreal.mdx b/src/platform-includes/getting-started-config/unreal.mdx index 3f08a5d9f285b..5480bfb521ef7 100644 --- a/src/platform-includes/getting-started-config/unreal.mdx +++ b/src/platform-includes/getting-started-config/unreal.mdx @@ -17,6 +17,6 @@ The window can be accessed by going to editor's menu: **Project Settings > Plugi ![Sentry settings window](unreal_window.png) -Alternatively, the `Initialize SDK automatically` option can be enabled in order to initialize the SDK on application startup. In this case, explicit SDK initialization won't be required. +By default, SDK is automatically initialized on application startup. Alternatively, the `Initialize SDK automatically` option can be disabled and in this case, explicit SDK initialization will be required. To override SDK settings at runtime, use the `InitializeWithSettings` method of the `SentrySubsystem` class. diff --git a/src/platform-includes/getting-started-install/unreal.mdx b/src/platform-includes/getting-started-install/unreal.mdx index d65beb505aa1f..e91e17f135daa 100644 --- a/src/platform-includes/getting-started-install/unreal.mdx +++ b/src/platform-includes/getting-started-install/unreal.mdx @@ -1,4 +1,4 @@ -The Unreal Engine (UE) SDK is currently compatible with **UE 4.27 or later** and supports **Windows**, **Linux**, **macOS**, **iOS**, and **Android**. +The Unreal Engine (UE) SDK is officially supported for the three latest UE versions. However, it is likely to be compatible with older engine versions as well depending on the specific features and functionality that you need. To build the SDK, download the latest sources from the [Releases page](https://github.com/getsentry/sentry-unreal/releases) and place it in the project's `Plugins` directory. On the next project launch, UE will prompt to build Sentry module. diff --git a/src/platform-includes/getting-started-primer/unreal.mdx b/src/platform-includes/getting-started-primer/unreal.mdx index d5ae5c18832a0..c9a7a5482f70f 100644 --- a/src/platform-includes/getting-started-primer/unreal.mdx +++ b/src/platform-includes/getting-started-primer/unreal.mdx @@ -1,23 +1,16 @@ -Configure Sentry with Unreal Engine. - - - -This SDK is a preview that packages Sentry's native SDKs into an Unreal Engine plugin. Alternatively, the stable Crash Reporter tool provided by Epic Games can be used in order to capture and alert of errors from your game. - - +Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unreal Engine specific features. It gives developers helpful hints for where and why an error or performance issue might have occurred. **Features:** - Native support for automatic crash error tracking for - Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++ - iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++ - - Windows and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps + - 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 Unreal Engine 5 -- [Crash Reporter Client](/platforms/unreal/setup-crashreporter/) provided along with Unreal Engine +- Compatible with [Crash Reporter Client](/platforms/unreal/setup-crashreporter/) provided along with Unreal Engine -[Crash Reporter Client](/platforms/unreal/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically. This step isn't required starting with UE 5.2 because the engine provides an API, which allows you to switch between default and third-party crash-handling solutions. +[Crash Reporter Client](/platforms/unreal/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically with UE 5.1 or older. Starting from UE 5.2 engine provides an API, which allows you to switch between default and third-party crash-handling solutions and thus this step isn't required. From 76a9a54f42fb260412aed32d79a409c5b957c2c0 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 9 Aug 2023 11:08:50 +0300 Subject: [PATCH 02/14] Update scopes page --- .../enriching-events/scopes/configure-scope/unreal.mdx | 8 +------- .../scopes/scope-callback-param/unreal.mdx | 6 ------ 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx b/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx index 41a0830416b4b..572ce5b140f7a 100644 --- a/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx +++ b/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx @@ -19,13 +19,7 @@ USentrySubsystem* SentrySubsystem = ...; SentrySubsystem->ConfigureScope(ScopeDelegate); ``` - - -`ConfigureScope` function is supported only on macOS, iOS and Android. - - - -For Windows and Mac, configure all data on the global scope. +Alternatively, all data can be configured on the global scope using dedicated methods of `SentrySubsystem` class. ```cpp USentrySubsystem* SentrySubsystem = ...; diff --git a/src/platform-includes/enriching-events/scopes/scope-callback-param/unreal.mdx b/src/platform-includes/enriching-events/scopes/scope-callback-param/unreal.mdx index 6978dc4545483..08092e580c1bd 100644 --- a/src/platform-includes/enriching-events/scopes/scope-callback-param/unreal.mdx +++ b/src/platform-includes/enriching-events/scopes/scope-callback-param/unreal.mdx @@ -1,9 +1,3 @@ - - -Local scopes are supported for iOS and Android only. - - - ```cpp FConfigureScopeDelegate ScopeDelegate; ScopeDelegate.BindDynamic(this, &USomeClass::HandleScopeDelegate); From 6f4d987c78bc001e2032672633a64ffc6427652c Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 10 Aug 2023 14:43:01 +0300 Subject: [PATCH 03/14] Add configuration section --- .../configuration/before-send/unreal.mdx | 30 ++++++++++++++++++ .../configuration/config-intro/unreal.mdx | 7 ++++ .../enriching-events/set-context/unreal.mdx | 2 +- .../enriching-events/set-tag/unreal.mdx | 2 +- .../enriching-events/set-user/unreal.mdx | 2 +- .../enriching-events/unset-user/unreal.mdx | 2 +- .../getting-started-primer/unreal.mdx | 4 +-- .../set-environment/unreal.mdx | 17 ++++++++++ src/platform-includes/set-release/unreal.mdx | 21 +++++++++--- .../common/configuration/draining.mdx | 1 + .../common/configuration/filtering.mdx | 6 ++-- src/platforms/common/configuration/index.mdx | 1 - .../common/configuration/options.mdx | 2 +- .../{ => configuration}/debug-symbols.mdx | 4 +-- .../setup-crashreporter.mdx | 5 +-- .../ue4-crash-reporter-settings.png | Bin .../ue4-crash-reporter.png | Bin .../ue4-include-crash-reporter.png | Bin .../ue4-include-debug-files.png | Bin .../unreal-debug-symbols.png | Bin src/wizard/unreal/index.md | 2 +- 21 files changed, 87 insertions(+), 21 deletions(-) create mode 100644 src/platform-includes/configuration/before-send/unreal.mdx create mode 100644 src/platform-includes/configuration/config-intro/unreal.mdx create mode 100644 src/platform-includes/set-environment/unreal.mdx rename src/platforms/unreal/{ => configuration}/debug-symbols.mdx (94%) rename src/platforms/unreal/{ => configuration}/setup-crashreporter.mdx (97%) rename src/platforms/unreal/{ => configuration}/ue4-crash-reporter-settings.png (100%) rename src/platforms/unreal/{ => configuration}/ue4-crash-reporter.png (100%) rename src/platforms/unreal/{ => configuration}/ue4-include-crash-reporter.png (100%) rename src/platforms/unreal/{ => configuration}/ue4-include-debug-files.png (100%) rename src/platforms/unreal/{ => configuration}/unreal-debug-symbols.png (100%) diff --git a/src/platform-includes/configuration/before-send/unreal.mdx b/src/platform-includes/configuration/before-send/unreal.mdx new file mode 100644 index 0000000000000..6e9e52cdd504c --- /dev/null +++ b/src/platform-includes/configuration/before-send/unreal.mdx @@ -0,0 +1,30 @@ +```cpp +UCLASS() +class USomeBeforeSendHandler : public USentryBeforeSendHandler +{ + GENERATED_BODY() + +public: + virtual USentryEvent* HandleBeforeSend_Implementation(USentryEvent* Event, USentryHint* Hint) override + { + UE_LOG(LogTemp, Log, TEXT("Hello from CPP beforeSend handler")); + return Super::HandleBeforeSend_Implementation(Event, Hint); + } +}; + +... + +FConfigureSettingsDelegate SettingsDelegate; +SettingsDelegate.BindDynamic(this, &USomeClass::HandleSettingsDelegate); + +void USomeClass::HandleSettingsDelegate(USentrySettings* Settings) +{ + Settings->BeforeSendHandler = USomeBeforeSendHandler::StaticCLass(); +} + +... + +USentrySubsystem* SentrySubsystem = ...; + +SentrySubsystem->InitializeWithSettings(SettingsDelegate); +``` diff --git a/src/platform-includes/configuration/config-intro/unreal.mdx b/src/platform-includes/configuration/config-intro/unreal.mdx new file mode 100644 index 0000000000000..80db8c84a2c00 --- /dev/null +++ b/src/platform-includes/configuration/config-intro/unreal.mdx @@ -0,0 +1,7 @@ +In order to provide native crash support, the Sentry SDK for Unreal Engine includes platform-specific SDKs, such as [Android](/platforms/android/), [Apple](/platforms/apple/), and [Native](/platforms/native/). Those SDKs share the options with which they get initialized. + +The UE layer self-initializes through the use of the [UGameInstance](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Engine/Engine/UGameInstance/) subsystem. + + + Not all options can be used on all platforms. + diff --git a/src/platform-includes/enriching-events/set-context/unreal.mdx b/src/platform-includes/enriching-events/set-context/unreal.mdx index 9ac55aa51c0ab..89045f9afee0e 100644 --- a/src/platform-includes/enriching-events/set-context/unreal.mdx +++ b/src/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](unreal_set_context.png) -Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/setup-crashreporter/#configure-attributes). +Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). diff --git a/src/platform-includes/enriching-events/set-tag/unreal.mdx b/src/platform-includes/enriching-events/set-tag/unreal.mdx index 75eb889eceef9..757913224fdca 100644 --- a/src/platform-includes/enriching-events/set-tag/unreal.mdx +++ b/src/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](unreal_set_tag.png) -Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/setup-crashreporter/#configure-attributes). +Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-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/src/platform-includes/enriching-events/set-user/unreal.mdx b/src/platform-includes/enriching-events/set-user/unreal.mdx index d551d005f4663..3fa36ddd72393 100644 --- a/src/platform-includes/enriching-events/set-user/unreal.mdx +++ b/src/platform-includes/enriching-events/set-user/unreal.mdx @@ -18,4 +18,4 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set user](unreal_set_user.png) -Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/setup-crashreporter/#configure-attributes). +Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/configuration/setup-crashreporter/#configure-attributes). diff --git a/src/platform-includes/enriching-events/unset-user/unreal.mdx b/src/platform-includes/enriching-events/unset-user/unreal.mdx index 95113968c1ca7..e37e73144cdbe 100644 --- a/src/platform-includes/enriching-events/unset-user/unreal.mdx +++ b/src/platform-includes/enriching-events/unset-user/unreal.mdx @@ -8,4 +8,4 @@ Or in blueprint: ![Unset user](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/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/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. diff --git a/src/platform-includes/getting-started-primer/unreal.mdx b/src/platform-includes/getting-started-primer/unreal.mdx index c9a7a5482f70f..599ad33a4c791 100644 --- a/src/platform-includes/getting-started-primer/unreal.mdx +++ b/src/platform-includes/getting-started-primer/unreal.mdx @@ -7,10 +7,10 @@ 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/setup-crashreporter/) provided along with Unreal Engine +- Compatible with [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine -[Crash Reporter Client](/platforms/unreal/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically with UE 5.1 or older. Starting from UE 5.2 engine provides an API, which allows you to switch between default and third-party crash-handling solutions and thus this step isn't required. +[Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically with UE 5.1 or older. Starting from UE 5.2 engine provides an API, which allows you to switch between default and third-party crash-handling solutions and thus this step isn't required. diff --git a/src/platform-includes/set-environment/unreal.mdx b/src/platform-includes/set-environment/unreal.mdx new file mode 100644 index 0000000000000..fc8af97d088e5 --- /dev/null +++ b/src/platform-includes/set-environment/unreal.mdx @@ -0,0 +1,17 @@ +```cpp +FConfigureSettingsDelegate SettingsDelegate; +SettingsDelegate.BindDynamic(this, &USomeClass::HandleSettingsDelegate); + +void USomeClass::HandleSettingsDelegate(USentrySettings* Settings) +{ + Settings->Environment = FString(TEXT("MyEnvironment")); +} + +... + +USentrySubsystem* SentrySubsystem = ...; + +SentrySubsystem->InitializeWithSettings(SettingsDelegate); +``` + +By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. Otherwise, the default environment can be `Release`, `Development` or `Debug` depending on build configuration. Also, it's possible override environment value manually. diff --git a/src/platform-includes/set-release/unreal.mdx b/src/platform-includes/set-release/unreal.mdx index 41a1dc988ddee..4b592c15e9176 100644 --- a/src/platform-includes/set-release/unreal.mdx +++ b/src/platform-includes/set-release/unreal.mdx @@ -1,7 +1,18 @@ -To configure Unreal to send release information, set the release [during -initialization](/platforms/unreal/setup-crashreporter/#configure-attributes): - ```cpp -TSharedPtr config = MakeShareable(new FJsonObject); -config->SetStringField("release", "my-project-name@2.3.12"); +FConfigureSettingsDelegate SettingsDelegate; +SettingsDelegate.BindDynamic(this, &USomeClass::HandleSettingsDelegate); + +void USomeClass::HandleSettingsDelegate(USentrySettings* Settings) +{ + Settings->OverrideReleaseName = true; + Settings->Release = FString(TEXT("MyRelease")); +} + +... + +USentrySubsystem* SentrySubsystem = ...; + +SentrySubsystem->InitializeWithSettings(SettingsDelegate); ``` + +By default the SDK will call `FApp::GetProjectName()` and read `ProjectVersion` value from `DefaultGame.ini` to create the release in the format `$"{ProjectName}@{ProjectVersion}".` Also, it's possible override release name manually. diff --git a/src/platforms/common/configuration/draining.mdx b/src/platforms/common/configuration/draining.mdx index b74eab0b4d53d..18f4f92ac74db 100644 --- a/src/platforms/common/configuration/draining.mdx +++ b/src/platforms/common/configuration/draining.mdx @@ -8,6 +8,7 @@ notSupported: - unity - php - elixir + - unreal --- The default behavior of most SDKs is to send out events over the network diff --git a/src/platforms/common/configuration/filtering.mdx b/src/platforms/common/configuration/filtering.mdx index 227e4e6b12601..dd074d985173a 100644 --- a/src/platforms/common/configuration/filtering.mdx +++ b/src/platforms/common/configuration/filtering.mdx @@ -24,7 +24,7 @@ All Sentry SDKs support the callback m Note also that breadcrumbs can be filtered, as discussed in [our Breadcrumbs documentation](/product/error-monitoring/breadcrumbs/). - + #### Event Hints @@ -38,7 +38,7 @@ When the SDK creates an event or breadcrumb for transmission, that transmission - + ### Using Hints @@ -92,7 +92,7 @@ You can use the option to filter out - + ## Filtering Transaction Events diff --git a/src/platforms/common/configuration/index.mdx b/src/platforms/common/configuration/index.mdx index 8a8656e84f192..ce8a62c4faf3a 100644 --- a/src/platforms/common/configuration/index.mdx +++ b/src/platforms/common/configuration/index.mdx @@ -8,7 +8,6 @@ notSupported: "native.wasm", "perl", "kotlin", - "unreal", ] description: "Additional configuration options for the SDK." sidebar_order: 5 diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 300573db0f545..274dd8bbe402a 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -701,7 +701,7 @@ This function is called with a backend-specific event object, and can return a m - + This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like. diff --git a/src/platforms/unreal/debug-symbols.mdx b/src/platforms/unreal/configuration/debug-symbols.mdx similarity index 94% rename from src/platforms/unreal/debug-symbols.mdx rename to src/platforms/unreal/configuration/debug-symbols.mdx index 29bdeba7f9f08..da75fd260a033 100644 --- a/src/platforms/unreal/debug-symbols.mdx +++ b/src/platforms/unreal/configuration/debug-symbols.mdx @@ -1,5 +1,5 @@ --- -title: Upload Debug Symbols +title: Debug Symbols Uploading description: "Learn how the Unreal Engine SDK handles debug symbols upload." --- @@ -13,7 +13,7 @@ For Android, debug symbols upload is handled by [Sentry Android Gradle Plugin](/ The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enter the [Auth Token](https://sentry.io/api/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available. -![The UE4 debug symbols ppload configuration](unreal-debug-symbols.png) +![The UE4 debug symbols upload configuration](unreal-debug-symbols.png) ### Manual Upload Using sentry-cli diff --git a/src/platforms/unreal/setup-crashreporter.mdx b/src/platforms/unreal/configuration/setup-crashreporter.mdx similarity index 97% rename from src/platforms/unreal/setup-crashreporter.mdx rename to src/platforms/unreal/configuration/setup-crashreporter.mdx index fe2dbd8f9866f..4b89a7d1d07ec 100644 --- a/src/platforms/unreal/setup-crashreporter.mdx +++ b/src/platforms/unreal/configuration/setup-crashreporter.mdx @@ -1,8 +1,9 @@ --- -title: Setup Crash Reporter Client -description: "Learn about Sentry's integration with Unreal Engine 4 (UE4)." +title: Crash Reporter Client +description: "Learn about Sentry's Unreal Engine integration with Crash Reporter Client." redirect_from: - /platforms/unreal/setup-crashreport/ + - /platforms/unreal/setup-crashreporter/ --- Installation of a Sentry SDK is not required in order to capture the crashes of your diff --git a/src/platforms/unreal/ue4-crash-reporter-settings.png b/src/platforms/unreal/configuration/ue4-crash-reporter-settings.png similarity index 100% rename from src/platforms/unreal/ue4-crash-reporter-settings.png rename to src/platforms/unreal/configuration/ue4-crash-reporter-settings.png diff --git a/src/platforms/unreal/ue4-crash-reporter.png b/src/platforms/unreal/configuration/ue4-crash-reporter.png similarity index 100% rename from src/platforms/unreal/ue4-crash-reporter.png rename to src/platforms/unreal/configuration/ue4-crash-reporter.png diff --git a/src/platforms/unreal/ue4-include-crash-reporter.png b/src/platforms/unreal/configuration/ue4-include-crash-reporter.png similarity index 100% rename from src/platforms/unreal/ue4-include-crash-reporter.png rename to src/platforms/unreal/configuration/ue4-include-crash-reporter.png diff --git a/src/platforms/unreal/ue4-include-debug-files.png b/src/platforms/unreal/configuration/ue4-include-debug-files.png similarity index 100% rename from src/platforms/unreal/ue4-include-debug-files.png rename to src/platforms/unreal/configuration/ue4-include-debug-files.png diff --git a/src/platforms/unreal/unreal-debug-symbols.png b/src/platforms/unreal/configuration/unreal-debug-symbols.png similarity index 100% rename from src/platforms/unreal/unreal-debug-symbols.png rename to src/platforms/unreal/configuration/unreal-debug-symbols.png diff --git a/src/wizard/unreal/index.md b/src/wizard/unreal/index.md index e6eb6e9a8663d..3fbe3a9313853 100644 --- a/src/wizard/unreal/index.md +++ b/src/wizard/unreal/index.md @@ -42,7 +42,7 @@ ___PUBLIC_DSN___ ## Crash Reporter Client -For Windows and Mac, [Crash Reporter Client](/platforms/unreal/setup-crashreporter/) provided along with Unreal Engine has to be configured in order to capture errors automatically. +For Windows and Mac, [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine has to be configured in order to capture errors automatically. ### Include the UE4 Crash Reporter From ed41ee35d67d7cb0e6de4cf0eb073843e8945c66 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 10 Aug 2023 16:38:12 +0300 Subject: [PATCH 04/14] Add features --- src/platform-includes/getting-started-primer/unreal.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/platform-includes/getting-started-primer/unreal.mdx b/src/platform-includes/getting-started-primer/unreal.mdx index 599ad33a4c791..38dab2eb601e0 100644 --- a/src/platform-includes/getting-started-primer/unreal.mdx +++ b/src/platform-includes/getting-started-primer/unreal.mdx @@ -8,6 +8,7 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea - 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 +- [Release health](/platforms/unreal/configuration/releases/) to keep track of crash free users and sessions From f3d0b2ddfb97c085bb80414648148c3e640af527 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Mon, 14 Aug 2023 09:46:26 +0300 Subject: [PATCH 05/14] Fix note --- src/platform-includes/configuration/config-intro/unreal.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/platform-includes/configuration/config-intro/unreal.mdx b/src/platform-includes/configuration/config-intro/unreal.mdx index 80db8c84a2c00..3744b9c033d66 100644 --- a/src/platform-includes/configuration/config-intro/unreal.mdx +++ b/src/platform-includes/configuration/config-intro/unreal.mdx @@ -3,5 +3,7 @@ In order to provide native crash support, the Sentry SDK for Unreal Engine inclu The UE layer self-initializes through the use of the [UGameInstance](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Engine/Engine/UGameInstance/) subsystem. - Not all options can be used on all platforms. + +Not all options can be used on all platforms. + From 14337c1eb3d28dd58e085843179a908ce8ab5ca4 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:28:22 +0300 Subject: [PATCH 06/14] Update src/platform-includes/set-release/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/set-release/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/set-release/unreal.mdx b/src/platform-includes/set-release/unreal.mdx index 4b592c15e9176..a022bdfc16206 100644 --- a/src/platform-includes/set-release/unreal.mdx +++ b/src/platform-includes/set-release/unreal.mdx @@ -15,4 +15,4 @@ USentrySubsystem* SentrySubsystem = ...; SentrySubsystem->InitializeWithSettings(SettingsDelegate); ``` -By default the SDK will call `FApp::GetProjectName()` and read `ProjectVersion` value from `DefaultGame.ini` to create the release in the format `$"{ProjectName}@{ProjectVersion}".` Also, it's possible override release name manually. +By default, the SDK will call `FApp::GetProjectName()` and read the `ProjectVersion` value from `DefaultGame.ini` to create the release in the format `$"{ProjectName}@{ProjectVersion}"`. It's possible to override the release name manually. From c195609e4ea65fc74c71056796640113d4d94857 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:28:34 +0300 Subject: [PATCH 07/14] Update src/platform-includes/set-environment/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/set-environment/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/set-environment/unreal.mdx b/src/platform-includes/set-environment/unreal.mdx index fc8af97d088e5..7f4c149946fc6 100644 --- a/src/platform-includes/set-environment/unreal.mdx +++ b/src/platform-includes/set-environment/unreal.mdx @@ -14,4 +14,4 @@ USentrySubsystem* SentrySubsystem = ...; SentrySubsystem->InitializeWithSettings(SettingsDelegate); ``` -By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. Otherwise, the default environment can be `Release`, `Development` or `Debug` depending on build configuration. Also, it's possible override environment value manually. +By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value manually. From 4dfaec2c43c00d3453fc16ac6e40ed752522a082 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:28:51 +0300 Subject: [PATCH 08/14] Update src/platform-includes/enriching-events/set-context/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/enriching-events/set-context/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/enriching-events/set-context/unreal.mdx b/src/platform-includes/enriching-events/set-context/unreal.mdx index 89045f9afee0e..75863fe64f4cc 100644 --- a/src/platform-includes/enriching-events/set-context/unreal.mdx +++ b/src/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](unreal_set_context.png) -Alternatively, this configuration cab 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/setup-crashreporter/#configure-attributes). From 2414adc2ef82c9d0eb37d167db490ffa878527e9 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:28:59 +0300 Subject: [PATCH 09/14] Update src/platform-includes/enriching-events/set-tag/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/enriching-events/set-tag/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/enriching-events/set-tag/unreal.mdx b/src/platform-includes/enriching-events/set-tag/unreal.mdx index 757913224fdca..34dd74d3fbb59 100644 --- a/src/platform-includes/enriching-events/set-tag/unreal.mdx +++ b/src/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](unreal_set_tag.png) -Alternatively, this configuration cab 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/setup-crashreporter/#configure-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. From 36bbd32f565d35794287ef606a1cb5a179ce75fd Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:29:06 +0300 Subject: [PATCH 10/14] Update src/platform-includes/enriching-events/set-user/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/enriching-events/set-user/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/enriching-events/set-user/unreal.mdx b/src/platform-includes/enriching-events/set-user/unreal.mdx index 3fa36ddd72393..4bfebe7855703 100644 --- a/src/platform-includes/enriching-events/set-user/unreal.mdx +++ b/src/platform-includes/enriching-events/set-user/unreal.mdx @@ -18,4 +18,4 @@ The same result can be achieved by calling corresponding function in blueprint: ![Set user](unreal_set_user.png) -Alternatively, this configuration cab 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/setup-crashreporter/#configure-attributes). From 08c204df451d4a4be5978890bd10333531bff855 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:29:45 +0300 Subject: [PATCH 11/14] Update src/platform-includes/getting-started-config/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/getting-started-config/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/getting-started-config/unreal.mdx b/src/platform-includes/getting-started-config/unreal.mdx index 5480bfb521ef7..91570a3ce23cf 100644 --- a/src/platform-includes/getting-started-config/unreal.mdx +++ b/src/platform-includes/getting-started-config/unreal.mdx @@ -17,6 +17,6 @@ The window can be accessed by going to editor's menu: **Project Settings > Plugi ![Sentry settings window](unreal_window.png) -By default, SDK is automatically initialized on application startup. Alternatively, the `Initialize SDK automatically` option can be disabled and in this case, explicit SDK initialization will be required. +By default, the SDK is automatically initialized on application startup. Alternatively, the `Initialize SDK automatically` option can be disabled and in this case, explicit SDK initialization is required. To override SDK settings at runtime, use the `InitializeWithSettings` method of the `SentrySubsystem` class. From 2dd99b9eab3652d54e305307ef1760812fbb9239 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Wed, 16 Aug 2023 15:30:33 +0300 Subject: [PATCH 12/14] Update src/platform-includes/getting-started-primer/unreal.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- src/platform-includes/getting-started-primer/unreal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform-includes/getting-started-primer/unreal.mdx b/src/platform-includes/getting-started-primer/unreal.mdx index 38dab2eb601e0..eca2d977df4e2 100644 --- a/src/platform-includes/getting-started-primer/unreal.mdx +++ b/src/platform-includes/getting-started-primer/unreal.mdx @@ -12,6 +12,6 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea -[Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically with UE 5.1 or older. Starting from UE 5.2 engine provides an API, which allows you to switch between default and third-party crash-handling solutions and thus this step isn't required. +[Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically with UE 5.1 or older. Starting from UE 5.2, the provided API allows you to switch between default and third-party crash-handling solutions, so this step isn't required. From 043f2dc37c463d83d77f50dd0f0ef1bc0271bad5 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Fri, 18 Aug 2023 14:40:14 +0300 Subject: [PATCH 13/14] Update src/platforms/unreal/configuration/debug-symbols.mdx Co-authored-by: Stefan Jandl --- src/platforms/unreal/configuration/debug-symbols.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/unreal/configuration/debug-symbols.mdx b/src/platforms/unreal/configuration/debug-symbols.mdx index da75fd260a033..58be604559a1b 100644 --- a/src/platforms/unreal/configuration/debug-symbols.mdx +++ b/src/platforms/unreal/configuration/debug-symbols.mdx @@ -13,7 +13,7 @@ For Android, debug symbols upload is handled by [Sentry Android Gradle Plugin](/ The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enter the [Auth Token](https://sentry.io/api/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available. -![The UE4 debug symbols upload configuration](unreal-debug-symbols.png) +![The Unreal Engine debug symbols upload configuration](unreal-debug-symbols.png) ### Manual Upload Using sentry-cli From 07b90649c9a83a8d74313069d4764c831fa78bc9 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Fri, 18 Aug 2023 14:40:24 +0300 Subject: [PATCH 14/14] Update src/wizard/unreal/index.md Co-authored-by: Stefan Jandl --- src/wizard/unreal/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/wizard/unreal/index.md b/src/wizard/unreal/index.md index 3fbe3a9313853..7259e716e7a20 100644 --- a/src/wizard/unreal/index.md +++ b/src/wizard/unreal/index.md @@ -44,7 +44,7 @@ ___PUBLIC_DSN___ For Windows and Mac, [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine has to be configured in order to capture errors automatically. -### Include the UE4 Crash Reporter +### Include the Unreal Engine Crash Reporter You can add the crash reporter client to your game in **Project Settings**.