Skip to content

Commit 0c427cb

Browse files
authored
Unreal: Document and add SendDefaultPii = true to onboarding docs (#13435)
* Add `SendDefaultPii` to options list * Add code SDK configuration snippet highlighting `SendDefaultPii` option * Update unreal.mdx * Update unreal.mdx
1 parent 5117609 commit 0c427cb

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

docs/platforms/unreal/configuration/options.mdx

+16
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,22 @@ Grouping in Sentry is different for events with stack traces and without. As a r
7676

7777
</ConfigKey>
7878

79+
<ConfigKey name="send-default-pii">
80+
81+
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
82+
83+
<Alert>
84+
85+
If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details.
86+
87+
</Alert>
88+
89+
This option is turned off by default.
90+
91+
If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/).
92+
93+
</ConfigKey>
94+
7995
<ConfigKey name="attach-screenshot">
8096

8197
Takes a screenshot of the application when an error happens and includes it as an attachment.

platform-includes/getting-started-config/unreal.mdx

+18
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,21 @@ The window can be accessed by going to editor's menu: **Project Settings > Plugi
2121
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.
2222

2323
To override SDK settings at runtime, use the `InitializeWithSettings` method of the `SentrySubsystem` class.
24+
25+
```cpp
26+
FConfigureSettingsDelegate OnConfigureSettings;
27+
OnConfigureSettings.BindDynamic(this, &UMyGameInstance::ConfigureSentrySettings);
28+
29+
void UMyGameInstance::ConfigureSentrySettings(USentrySettings* Settings)
30+
{
31+
Settings->Dsn = TEXT("DSN");
32+
33+
// Add data like request headers, user ip address, device name, etc.
34+
Settings->SendDefaultPii = true;
35+
}
36+
37+
...
38+
39+
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();
40+
SentrySubsystem->InitializeWithSettings(OnConfigureSettings);
41+
```

0 commit comments

Comments
 (0)