feat(Unity): Updated options and error capture explainer
#12904
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d added explainer on how the SDK captures errors
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 210 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
reviewed
Mar 3, 2025
coolguyzone
approved these changes
Mar 3, 2025
Co-authored-by: Alex Krawiec <[email protected]>
bruno-garcia
reviewed
Mar 4, 2025
bruno-garcia
reviewed
Mar 4, 2025
|
|
||
| <ConfigKey name="database-path" supported={["native"]}> | ||
| Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it, guaranteeing that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>. |
There was a problem hiding this comment.
"Some SDKs" seems generic. Here we know it's Unity. Is it benefitial to set something manually in Unity? I think our auto detection is quite on point since it relies on the Unitys' version already right?
Suggested change
| Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it, guaranteeing that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>. |
|
|
||
| By default, the SDK reports `editor` when running inside the Unity Editor. Otherwise, the default environment is `production`. | ||
| Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default. |
There was a problem hiding this comment.
How about being specific here too (what lingo makes more sense for Unity devs?)
Suggested change
| Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default. | |
| Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such Unity's APIs, .NET's APIs, or other packages and dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default. |
Comment on lines
+152
to
+155
| - Universal Windows platform (UWP) applications | ||
| - WinForms applications | ||
| - Windows Presentation Foundation (WPF) applications | ||
| - Single user console applications |
There was a problem hiding this comment.
how about listing Unity deployment types here? Unity Server, vs Unity on a Mobile, Desktop or Web app?
| - Windows Presentation Foundation (WPF) applications | ||
| - Single user console applications | ||
|
|
||
| Defaults to `false`, unless in Blazor WASM, MAUI, Unity, or Xamarin where the default is `true`. |
There was a problem hiding this comment.
Not relevant
Suggested change
| Defaults to `false`, unless in Blazor WASM, MAUI, Unity, or Xamarin where the default is `true`. |
| Once enabled, this feature automatically captures HTTP client errors, like bad response codes, as error events and reports them to Sentry. | ||
| This option can be used to supply a server name. When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server. | ||
|
|
||
| For ASP.NET and ASP.NET Core applications, the value will default to the server's name. For other application types, the value will default to the computer's name only when the `SendDefaultPii` is set to `true`, because the computer's name can be considered personally identifiable information (PII) in the case of a desktop or mobile application. |
|
|
||
| ## UnityLogHandlerIntegration | ||
|
|
||
| The SDK uses the `UnityLogHandlerIntegration` to hook into Unity's logging system. From there it receives all log messages that are logged via the `Debug.Log`, `Debug.LogWarning`, and `Debug.LogError` methods and those log messages are added as breadcrumbs to future events. By default, the SDK will also automatically capture messages logged via `Debug.LogError` as error events and send them to Sentry. This behaviour can be disabled by unchecking the automatic capture of `Debug.LogError` on the `Enrichment` tab, or programmatically, by setting the `CaptureLogErrorEvents` option to `false` in the [configure callback](/platforms/unity/configuration/options/programmatic-configuration). |
There was a problem hiding this comment.
tab could be in Sentry (sentry.io)
Suggested change
| The SDK uses the `UnityLogHandlerIntegration` to hook into Unity's logging system. From there it receives all log messages that are logged via the `Debug.Log`, `Debug.LogWarning`, and `Debug.LogError` methods and those log messages are added as breadcrumbs to future events. By default, the SDK will also automatically capture messages logged via `Debug.LogError` as error events and send them to Sentry. This behaviour can be disabled by unchecking the automatic capture of `Debug.LogError` on the `Enrichment` tab, or programmatically, by setting the `CaptureLogErrorEvents` option to `false` in the [configure callback](/platforms/unity/configuration/options/programmatic-configuration). | |
| The SDK uses the `UnityLogHandlerIntegration` to hook into Unity's logging system. From there it receives all log messages that are logged via the `Debug.Log`, `Debug.LogWarning`, and `Debug.LogError` methods and those log messages are added as breadcrumbs to future events. By default, the SDK will also automatically capture messages logged via `Debug.LogError` as error events and send them to Sentry. This behaviour can be disabled by unchecking the automatic capture of `Debug.LogError` on the `Enrichment` tab in the editor (Tools->Sentry), or programmatically, by setting the `CaptureLogErrorEvents` option to `false` in the [configure callback](/platforms/unity/configuration/options/programmatic-configuration). |
|
|
||
| ### Stack Trace Support & Line Numbers | ||
|
|
||
| If [configured](https://docs.unity3d.com/6000.0/Documentation/Manual/stack-trace.html), Unity will include the stack traces with the log messages as raw strings. The SDK is able to parse and display this stack trace in the issues details. |
There was a problem hiding this comment.
Suggested change
| If [configured](https://docs.unity3d.com/6000.0/Documentation/Manual/stack-trace.html), Unity will include the stack traces with the log messages as raw strings. The SDK is able to parse and display this stack trace in the issues details. | |
| If [configured](https://docs.unity3d.com/6000.0/Documentation/Manual/stack-trace.html), Unity will include the stack traces with the log messages as raw strings. The Sentry SDK is able to parse and display this stack trace in the issue details page. |
|
|
||
| If [configured](https://docs.unity3d.com/6000.0/Documentation/Manual/stack-trace.html), Unity will include the stack traces with the log messages as raw strings. The SDK is able to parse and display this stack trace in the issues details. | ||
|
|
||
| If you're using Unity 6 or newer, you have the option to to enable the source code line numbers in the [player settings](https://docs.unity3d.com/6000.0/Documentation/Manual/il2cpp-managed-stack-traces.html). These line numbers are then part of the stringified stack trace and will be parsed by the SDK. Unfortunately, since there is no native exception at the time of logging, the SDK is not be able to provide line numbers otherwise. |
There was a problem hiding this comment.
Suggested change
| If you're using Unity 6 or newer, you have the option to to enable the source code line numbers in the [player settings](https://docs.unity3d.com/6000.0/Documentation/Manual/il2cpp-managed-stack-traces.html). These line numbers are then part of the stringified stack trace and will be parsed by the SDK. Unfortunately, since there is no native exception at the time of logging, the SDK is not be able to provide line numbers otherwise. | |
| If you're using Unity 6 or newer, you have the option to to enable the source code line numbers in the [player settings](https://docs.unity3d.com/6000.0/Documentation/Manual/il2cpp-managed-stack-traces.html). These line numbers are then part of the stringified stack trace and will be parsed by the SDK. In order to get line number for log messages, this option must be turned on. For `Log.LogException`, this option isn't required since Sentry can [symbolicate server-side](/platforms/unity/configuration/il2cpp/) the stack trace and add line mumbers. |
|
|
||
| <Alert> | ||
|
|
||
| The Unity SDK does not provide stack traces for messages. |
There was a problem hiding this comment.
Flip it around by saying what we do have, to help clarify what we don't.
Suggested change
| The Unity SDK does not provide stack traces for messages. | |
| The Sentry SDK for Unity only provides stack traces for captured Exceptions. Logged messages won't have line numbers. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.