Skip to content

Updated Unity options with missing defaults #15219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 23, 2025
+9 −9
Merged

Updated Unity options with missing defaults #15219

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b1f860
Updated Unity options with missing defaults
Oct 14, 2025
e33b0af
Update docs/platforms/unity/configuration/options/index.mdx
sfanahata Oct 22, 2025
43ac87b
Update docs/platforms/unity/configuration/options/index.mdx
sfanahata Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/platforms/unity/configuration/options/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,40 +84,40 @@ This variable controls the total amount of breadcrumbs that should be captured.

</SdkOption>

<SdkOption name="AttachStacktrace" type="bool">
<SdkOption name="AttachStacktrace" type="bool" defaultValue="true">

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.

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.

</SdkOption>

<SdkOption name="AttachScreenshot" type="bool">
<SdkOption name="AttachScreenshot" type="bool" defaultValue="false">

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

</SdkOption>

<SdkOption name="ScreenshotQuality" type="enum">
<SdkOption name="ScreenshotQuality" type="enum" defaultValue="high">

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

</SdkOption>

<SdkOption name="AttachViewHierarchy" type="bool">
<SdkOption name="AttachViewHierarchy" type="bool" defaultValue="false">

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`.

</SdkOption>

<SdkOption name="SendClientReports" type="bool">
<SdkOption name="SendClientReports" type="bool" defaultValue="true">

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.

</SdkOption>

<SdkOption name="CaptureFailedRequests" type="bool">
<SdkOption name="CaptureFailedRequests" type="bool" defaultValue="true">

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

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

## Tracing Options

<SdkOption name="TracesSampleRate" type="float">
<SdkOption name="TracesSampleRate" type="float" defaultValue="0.0">

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.

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

</SdkOption>

<SdkOption name="AutoStartupTraces" type="bool">
<SdkOption name="AutoStartupTraces" type="bool" defaultValue="true">

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

</SdkOption>

<SdkOption name="AutoSceneTraces" type="bool">
<SdkOption name="AutoSceneLoadTraces" type="bool" defaultValue="true">

Controls whether the SDK will automatically trace when loading scenes.

Expand Down
Loading