Add setting allowing to opt-out Crash Reporter wrapper instantiation (#1178)

* Add setting allowing to opt-out Crash Reporter wrapper intantiation

* Update changelog

Author: tustanivsky

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add plugin setting to opt out of automatic Crash Reporter context propagation ([#1178](https://github.com/getsentry/sentry-unreal/pull/1178))
+
 ### Fixes
 
 - Misleading screenshot capture logs on unsupported platforms ([#1180](https://github.com/getsentry/sentry-unreal/pull/1180))

plugin-dev/Source/Sentry/Private/Linux/LinuxSentrySubsystem.cpp

@@ -17,7 +17,10 @@ void FLinuxSentrySubsystem::InitWithSettings(const USentrySettings* Settings, US
 {
 	FGenericPlatformSentrySubsystem::InitWithSettings(Settings, BeforeSendHandler, BeforeBreadcrumbHandler, BeforeLogHandler, TraceSampler);
 
-	InitCrashReporter(Settings->GetEffectiveRelease(), Settings->GetEffectiveEnvironment());
+	if (Settings->EnableCrashReporterContextPropagation)
+	{
+		InitCrashReporter(Settings->GetEffectiveRelease(), Settings->GetEffectiveEnvironment());
+	}
 
 	// Add platform context if detected
 	if (IsEnabled())

plugin-dev/Source/Sentry/Private/Microsoft/MicrosoftSentrySubsystem.cpp

@@ -47,12 +47,15 @@ void FMicrosoftSentrySubsystem::InitWithSettings(const USentrySettings* Settings
 		FPlatformMisc::SetCrashHandlingType(Settings->EnableAutoCrashCapturing ? ECrashHandlingType::Disabled : ECrashHandlingType::Default);
 	}
 
-	if (FPlatformMisc::GetCrashHandlingType() == ECrashHandlingType::Default)
+	if (FPlatformMisc::GetCrashHandlingType() == ECrashHandlingType::Default && Settings->EnableCrashReporterContextPropagation)
 	{
 		InitCrashReporter(Settings->GetEffectiveRelease(), Settings->GetEffectiveEnvironment());
 	}
 #else
-	InitCrashReporter(Settings->GetEffectiveRelease(), Settings->GetEffectiveEnvironment());
+	if (Settings->EnableCrashReporterContextPropagation)
+	{
+		InitCrashReporter(Settings->GetEffectiveRelease(), Settings->GetEffectiveEnvironment());
+	}
 #endif
 }
 

plugin-dev/Source/Sentry/Private/SentrySettings.cpp

@@ -63,6 +63,7 @@ USentrySettings::USentrySettings(const FObjectInitializer& ObjectInitializer)
 	, DiagnosticLevel(ESentryCliLogLevel::Info)
 	, UseLegacyGradlePlugin(false)
 	, CrashReporterUrl()
+	, EnableCrashReporterContextPropagation(true)
 	, bRequireUserConsent(false)
 	, bDefaultUserConsentGiven(true)
 	, bIsDirty(false)
@@ -92,7 +93,8 @@ void USentrySettings::PostEditChangeProperty(FPropertyChangedEvent& PropertyChan
 		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, IncludeSources) ||
 		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, UseLegacyGradlePlugin) ||
 		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, DiagnosticLevel) ||
-		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, CrashReporterUrl))
+		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, CrashReporterUrl) ||
+		PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(USentrySettings, EnableCrashReporterContextPropagation))
 	{
 		return;
 	}

plugin-dev/Source/Sentry/Public/SentrySettings.h

@@ -421,6 +421,10 @@ class SENTRY_API USentrySettings : public UObject
 		Meta = (DisplayName = "Crash Reporter Endpoint", ToolTip = "Endpoint that Unreal Engine Crah Reporter should use in order to upload crash data to Sentry."))
 	FString CrashReporterUrl;
 
+	UPROPERTY(Config, EditAnywhere, Category = "Crash Reporter",
+		Meta = (DisplayName = "Allow Crash Reporter context propagation", ToolTip = "Flag indicating whether to automatically propagate additional data (e.g., tags, context) set via Sentry SDK interface to Crash Reporter."))
+	bool EnableCrashReporterContextPropagation;
+
 	UPROPERTY(Config, EditAnywhere, Category = "General|Consent",
 		Meta = (DisplayName = "Require User Consent (for Windows/Linux only)", ToolTip = "True if user's consent is required before uploading crash data. Currently this feature is supported for Windows and Linux only."))
 	bool bRequireUserConsent;