Skip to content

Commit 198695d

Browse files
authored
Updated Unity options with missing defaults (#15219)
1 parent b5a1a53 commit 198695d

File tree

1 file changed

+9
-9
lines changed
  • docs/platforms/unity/configuration/options

1 file changed

+9
-9
lines changed

docs/platforms/unity/configuration/options/index.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,40 +84,40 @@ This variable controls the total amount of breadcrumbs that should be captured.
8484

8585
</SdkOption>
8686

87-
<SdkOption name="AttachStacktrace" type="bool">
87+
<SdkOption name="AttachStacktrace" type="bool" defaultValue="true">
8888

8989
When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
9090

9191
Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.
9292

9393
</SdkOption>
9494

95-
<SdkOption name="AttachScreenshot" type="bool">
95+
<SdkOption name="AttachScreenshot" type="bool" defaultValue="false">
9696

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

100100
</SdkOption>
101101

102-
<SdkOption name="ScreenshotQuality" type="enum">
102+
<SdkOption name="ScreenshotQuality" type="enum" defaultValue="high">
103103

104104
The quality of the attached screenshot. It can be set to `full`, `high`, `medium` or `low`.
105105

106106
</SdkOption>
107107

108-
<SdkOption name="AttachViewHierarchy" type="bool">
108+
<SdkOption name="AttachViewHierarchy" type="bool" defaultValue="false">
109109

110110
Captures the currently active scene's hierarchy and creates a `ViewHierarchy` when an error happens and includes it as an attachment. The creation is influenced by `MaxViewHierarchyRootObjects`, `MaxViewHierarchyDepth`, and `MaxViewHierarchyObjectChildCount`.
111111

112112
</SdkOption>
113113

114-
<SdkOption name="SendClientReports" type="bool">
114+
<SdkOption name="SendClientReports" type="bool" defaultValue="true">
115115

116116
Set this boolean to `false` to disable sending of client reports. Client reports are a protocol feature that let clients send status reports about themselves to Sentry. They are currently mainly used to emit outcomes for events that were never sent.
117117

118118
</SdkOption>
119119

120-
<SdkOption name="CaptureFailedRequests" type="bool">
120+
<SdkOption name="CaptureFailedRequests" type="bool" defaultValue="true">
121121

122122
Once enabled, this feature automatically captures HTTP client errors, like bad response codes, as error events and reports them to Sentry.
123123

@@ -239,7 +239,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events
239239

240240
## Tracing Options
241241

242-
<SdkOption name="TracesSampleRate" type="float">
242+
<SdkOption name="TracesSampleRate" type="float" defaultValue="0.0">
243243

244244
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="TracesSampler" /> must be defined to enable tracing.
245245

@@ -251,13 +251,13 @@ A function responsible for determining the percentage chance a given transaction
251251

252252
</SdkOption>
253253

254-
<SdkOption name="AutoStartupTraces" type="bool">
254+
<SdkOption name="AutoStartupTraces" type="bool" defaultValue="true">
255255

256256
Controls whether the SDK will automatically trace the app's startup.
257257

258258
</SdkOption>
259259

260-
<SdkOption name="AutoSceneTraces" type="bool">
260+
<SdkOption name="AutoSceneLoadTraces" type="bool" defaultValue="true">
261261

262262
Controls whether the SDK will automatically trace when loading scenes.
263263

0 commit comments

Comments
 (0)