From 4a98096b387b387d40c27dcb669237672fee6579 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 17 Apr 2025 15:23:21 +0300 Subject: [PATCH 01/10] Add manual configuration step to Unreal Engine wizard This also highlights `SendDefaultPii` setting usage --- .../app/gettingStartedDocs/unreal/unreal.tsx | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 167ca60abf1b42..1373ba15c7c2d1 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -30,6 +30,26 @@ void Verify() SentrySubsystem->CaptureMessage(TEXT("Capture message")); }`; +const getSettingsConfigureSnippet = () => ` +#include "SentrySubsystem.h" + +FConfigureSettingsDelegate OnConfigureSettings; +OnConfigureSettings.BindDynamic(this, &UMyGameInstance::ConfigureSentrySettings); + +void UMyGameInstance::ConfigureSentrySettings(USentrySettings* Settings) +{ + Settings->Dsn = TEXT("DSN"); + + // Add data like request headers, user ip address and device name, + // see https://docs.sentry.io/platforms/android/data-management/data-collected/ for more info + Settings->SendDefaultPii = true; +} + +... + +USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem(); +SentrySubsystem->InitializeWithSettings(OnConfigureSettings);`; + const getCrashReporterConfigSnippet = (params: Params) => ` [CrashReportClient] CrashReportClientVersion=1.0 @@ -87,6 +107,20 @@ const onboarding: OnboardingConfig = { language: 'url', code: params.dsn.public, }, + { + description: ( +

+ {tct( + "By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:", + { + strong: + } + )} +

+ ), + language: 'cpp', + code: getSettingsConfigureSnippet(), + }, ], }, ], From 97c32f8cd4239d8848be12b0a6d4cb82d1a9d962 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 17 Apr 2025 16:27:23 +0300 Subject: [PATCH 02/10] Update unreal.tsx --- static/app/gettingStartedDocs/unreal/unreal.tsx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 1373ba15c7c2d1..b134845d90e680 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -38,11 +38,10 @@ OnConfigureSettings.BindDynamic(this, &UMyGameInstance::ConfigureSentrySettings) void UMyGameInstance::ConfigureSentrySettings(USentrySettings* Settings) { - Settings->Dsn = TEXT("DSN"); + Settings->Dsn = TEXT("DSN"); - // Add data like request headers, user ip address and device name, - // see https://docs.sentry.io/platforms/android/data-management/data-collected/ for more info - Settings->SendDefaultPii = true; + // Add data like request headers, user ip address, device name, etc. + Settings->SendDefaultPii = true; } ... From a042706687834ae604be4320733aea326edbdf7d Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 22 Apr 2025 09:18:42 +0300 Subject: [PATCH 03/10] Update static/app/gettingStartedDocs/unreal/unreal.tsx Co-authored-by: Simon Hellmayr --- static/app/gettingStartedDocs/unreal/unreal.tsx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index b134845d90e680..0eb977b0c76fcd 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -30,8 +30,7 @@ void Verify() SentrySubsystem->CaptureMessage(TEXT("Capture message")); }`; -const getSettingsConfigureSnippet = () => ` -#include "SentrySubsystem.h" +const getSettingsConfigureSnippet = () => `#include "SentrySubsystem.h" FConfigureSettingsDelegate OnConfigureSettings; OnConfigureSettings.BindDynamic(this, &UMyGameInstance::ConfigureSentrySettings); From 46c156818fe2bdef47e6d3bd2b478e8370d8365f Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 22 Apr 2025 09:53:55 +0300 Subject: [PATCH 04/10] Add DSN param to configure settings sniuppet --- static/app/gettingStartedDocs/unreal/unreal.tsx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 0eb977b0c76fcd..9c07e2d9c56597 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -30,14 +30,15 @@ void Verify() SentrySubsystem->CaptureMessage(TEXT("Capture message")); }`; -const getSettingsConfigureSnippet = () => `#include "SentrySubsystem.h" +const getSettingsConfigureSnippet = (params: Params) => ` +#include "SentrySubsystem.h" FConfigureSettingsDelegate OnConfigureSettings; OnConfigureSettings.BindDynamic(this, &UMyGameInstance::ConfigureSentrySettings); void UMyGameInstance::ConfigureSentrySettings(USentrySettings* Settings) { - Settings->Dsn = TEXT("DSN"); + Settings->Dsn = TEXT("${params.dsn.public}"); // Add data like request headers, user ip address, device name, etc. Settings->SendDefaultPii = true; @@ -117,7 +118,7 @@ const onboarding: OnboardingConfig = {

), language: 'cpp', - code: getSettingsConfigureSnippet(), + code: getSettingsConfigureSnippet(params), }, ], }, From f983bc92bfe2a8cd53a8eba838b743090cb7298f Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 22 Apr 2025 14:59:30 +0300 Subject: [PATCH 05/10] Try using fragment --- .../app/gettingStartedDocs/unreal/unreal.tsx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 9c07e2d9c56597..66e0a5586dafab 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -108,14 +108,16 @@ const onboarding: OnboardingConfig = { }, { description: ( -

- {tct( - "By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:", - { - strong: - } - )} -

+ +

+ {tct( + "By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:", + { + strong: + } + )} +

+ ), language: 'cpp', code: getSettingsConfigureSnippet(params), From 81a3c391762d28a07a6bb0c799dad56679649fe6 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 22 Apr 2025 15:05:40 +0300 Subject: [PATCH 06/10] Fix lint --- static/app/gettingStartedDocs/unreal/unreal.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 66e0a5586dafab..520ad003f41443 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -111,9 +111,9 @@ const onboarding: OnboardingConfig = {

{tct( - "By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:", + 'By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:', { - strong: + strong: , } )}

From e0f35eba266f21e4e5ebad9d350462d6e1acd012 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 24 Apr 2025 13:02:10 +0300 Subject: [PATCH 07/10] Update static/app/gettingStartedDocs/unreal/unreal.tsx Co-authored-by: Priscila Oliveira --- static/app/gettingStartedDocs/unreal/unreal.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 520ad003f41443..ac3723cffe1588 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -111,7 +111,7 @@ const onboarding: OnboardingConfig = {

{tct( - 'By default, the SDK is automatically initialized on application startup. Alternatively, the [strong:Initialize SDK automatically] option can be disabled and in this case, explicit SDK initialization is required:', + 'By default, the SDK initializes automatically when the application starts. Alternatively, you can disable the [strong:Initialize SDK automatically] option, in which case you'll need to initialize the SDK manually', { strong: , } From d75765169d23d59172e439ae76c8a2c74256437f Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 24 Apr 2025 13:02:49 +0300 Subject: [PATCH 08/10] Update unreal.tsx --- .../app/gettingStartedDocs/unreal/unreal.tsx | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index ac3723cffe1588..05cea4d013abff 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -108,16 +108,14 @@ const onboarding: OnboardingConfig = { }, { description: ( - -

- {tct( - 'By default, the SDK initializes automatically when the application starts. Alternatively, you can disable the [strong:Initialize SDK automatically] option, in which case you'll need to initialize the SDK manually', - { - strong: , - } - )} -

- +

+ {tct( + 'By default, the SDK initializes automatically when the application starts. Alternatively, you can disable the [strong:Initialize SDK automatically] option, in which case you'll need to initialize the SDK manually', + { + strong: , + } + )} +

), language: 'cpp', code: getSettingsConfigureSnippet(params), From 62352e9fbe43e56912061c1fcadf109c006396c8 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Thu, 24 Apr 2025 13:07:44 +0300 Subject: [PATCH 09/10] Fix string --- static/app/gettingStartedDocs/unreal/unreal.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 05cea4d013abff..3a7834dcde96c5 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -110,7 +110,7 @@ const onboarding: OnboardingConfig = { description: (

{tct( - 'By default, the SDK initializes automatically when the application starts. Alternatively, you can disable the [strong:Initialize SDK automatically] option, in which case you'll need to initialize the SDK manually', + "By default, the SDK initializes automatically when the application starts. Alternatively, you can disable the [strong:Initialize SDK automatically] option, in which case you'll need to initialize the SDK manually", { strong: , } From 8774af36c29e2a09ad2dd15c62eae7ab70adcb04 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Mon, 28 Apr 2025 21:44:33 +0300 Subject: [PATCH 10/10] Update unreal.tsx --- static/app/gettingStartedDocs/unreal/unreal.tsx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/static/app/gettingStartedDocs/unreal/unreal.tsx b/static/app/gettingStartedDocs/unreal/unreal.tsx index 3a7834dcde96c5..d01e9723e6cc58 100644 --- a/static/app/gettingStartedDocs/unreal/unreal.tsx +++ b/static/app/gettingStartedDocs/unreal/unreal.tsx @@ -40,7 +40,8 @@ void UMyGameInstance::ConfigureSentrySettings(USentrySettings* Settings) { Settings->Dsn = TEXT("${params.dsn.public}"); - // Add data like request headers, user ip address, device name, etc. + // Add data like user ip address and device name + // See https://docs.sentry.io/platforms/unreal/data-management/data-collected/ for more info Settings->SendDefaultPii = true; }