Skip to content

Commit c3aa432

Browse files
sfanahataShannon Anahata
andauthored
Updated Unreal options with defaults (#15233)
## DESCRIBE YOUR PR Making sure the metadata is up to date for Unreal options since migrating in full to SDKoption. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent e5e9176 commit c3aa432

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/platforms/unreal/configuration/options.mdx

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,25 @@ This variable controls the total amount of breadcrumbs that should be captured.
6464

6565
</SdkOption>
6666

67-
<SdkOption name="AutomaticBreadcrumbs" type="bool">
67+
<SdkOption name="AutomaticBreadcrumbs" type="struct" defaultNote="all fields default to false">
6868

69-
Configures whether to automatically add breadcrumbs on in-game events (i.e. when a game map is loaded or session ID is changed).
69+
Configures whether to automatically add breadcrumbs for specific in-game events. This is a struct containing boolean fields for different event types:
70+
- `bOnMapLoadingStarted` - when map loading starts
71+
- `bOnMapLoaded` - when map is loaded
72+
- `bOnGameStateClassChanged` - when game state changes
73+
- `bOnGameSessionIDChanged` - when game session ID changes
74+
- `bOnUserActivityStringChanged` - when user activity string changes
7075

7176
</SdkOption>
7277

73-
<SdkOption name="AutomaticBreadcrumbsForLogs" type="bool">
78+
<SdkOption name="AutomaticBreadcrumbsForLogs" type="struct" defaultNote="enabled for Fatal, Error, and Warning">
7479

75-
Configures whether to automatically add breadcrumbs for log messages with certain keywords (examples: `Fatal`, `Error`, `Warning`, `Log` and `Verbose`).
80+
Configures whether to automatically add breadcrumbs for log messages at specific verbosity levels. This is a struct containing boolean fields for different log levels:
81+
- `bOnFatalLog` - defaults to `true`
82+
- `bOnErrorLog` - defaults to `true`
83+
- `bOnWarningLog` - defaults to `true`
84+
- `bOnInfoLog` (Display/Log) - defaults to `false`
85+
- `bOnDebugLog` (Verbose/VeryVerbose) - defaults to `false`
7686

7787
</SdkOption>
7888

@@ -102,7 +112,7 @@ If you enable this option, be sure to manually remove what you don't want to sen
102112

103113
</SdkOption>
104114

105-
<SdkOption name="AttachScreenshot" type="bool">
115+
<SdkOption name="AttachScreenshot" type="bool" defaultValue="false">
106116

107117
Takes a screenshot of the application when an error happens and includes it as an attachment.
108118
Learn more about enriching events with screenshots in our <PlatformLink to="/enriching-events/screenshots/">Screenshots documentation</PlatformLink>.

0 commit comments

Comments
 (0)