From b6eb4d72c7dd1379ef1330254232cd521fca6e34 Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Tue, 3 Nov 2026 17:43:40 +0100 Subject: [PATCH 1/6] Correct configuration window tooltips and option docs --- CHANGELOG.md | 8 +++++++- .../ConfigurationWindow/AdvancedTab.cs | 8 ++------ src/Sentry.Unity.Editor/ConfigurationWindow/CoreTab.cs | 2 +- .../ConfigurationWindow/EnrichmentTab.cs | 9 ++++----- src/Sentry.Unity/SentryUnityOptions.cs | 3 ++- 5 files changed, 16 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 252fc315b..e6d93deba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### Fixes + +- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs no Org-Slug, and `Scene Traces` has no Unity version requirement. (PR_LINK) + ## 4.12.0 ### Behavioral Changes @@ -212,7 +218,7 @@ ### Features -- Added `options.AndroidNativeTombstoneEnabled` (default `false`) and `options.AndroidReportHistoricalTombstones` (default `false`) to enable reporting of native crashes captured by Android's `ApplicationExitInfo` API as Tombstones ([#2749](https://github.com/getsentry/sentry-unity/pull/2749)) +- Added `options.AndroidTombstoneEnabled` (default `false`) and `options.AndroidReportHistoricalTombstones` (default `false`) to enable reporting of native crashes captured by Android's `ApplicationExitInfo` API as Tombstones ([#2749](https://github.com/getsentry/sentry-unity/pull/2749)) ### Fixes diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs index 1d2940afb..3fa97546e 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs @@ -200,17 +200,13 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti "constructed exception. Capture a thrown exception to include its stack trace.", MessageType.Info); - if (!SentryUnityVersion.IsNewerOrEqualThan("2020.3")) - { - EditorGUILayout.HelpBox("The IL2CPP line number feature is supported from Unity version 2020.3 or newer and 2021.3 or newer onwards", MessageType.Warning); - } - else if (cliOptions is not null && !cliOptions.IsValid(null, EditorUserBuildSettings.development)) + if (cliOptions is not null && !cliOptions.IsValid(null, EditorUserBuildSettings.development)) { EditorGUILayout.BeginVertical(EditorStyles.helpBox); var errorIcon = EditorGUIUtility.IconContent("console.erroricon").image; var content = new GUIContent("The IL2CPP line number support relies on the Debug Symbol Upload to be enabled and configured." + - "\nAdditionally, this requires an Auth Token, an Org-Slug and the Project Name." + + "\nAdditionally, this requires an Auth Token and the Project Name." + "\nLearn more about how our IL2CPP support works in our docs.", errorIcon); EditorGUILayout.LabelField(content, EditorStyles.wordWrappedLabel); diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/CoreTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/CoreTab.cs index bf2709594..46f3cdc07 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/CoreTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/CoreTab.cs @@ -85,7 +85,7 @@ internal static void Display(ScriptableSentryUnityOptions options) options.AutoSceneLoadTraces = EditorGUILayout.Toggle( new GUIContent("Scene Traces ", "Whether the SDK should automatically create traces " + - "during scene loading. Requires Unity 2020.3 or newer."), + "during scene loading."), options.AutoSceneLoadTraces); options.AutoAwakeTraces = EditorGUILayout.Toggle( diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs index 0d5a29783..db8fcd2ee 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs @@ -18,8 +18,7 @@ internal static void Display(ScriptableSentryUnityOptions options) options.IsEnvironmentUser = EditorGUILayout.Toggle( new GUIContent("Auto Set UserName", "Whether to report the 'Environment.UserName' as " + - "the User affected in the event. Defaults to enabled on desktop " + - "platforms and disabled on mobile and console platforms."), + "the User affected in the event. Disabled by default."), options.IsEnvironmentUser); EditorGUI.indentLevel--; @@ -33,9 +32,9 @@ internal static void Display(ScriptableSentryUnityOptions options) { options.AttachScreenshot = EditorGUILayout.BeginToggleGroup( new GUIContent("Attach Screenshots to Events", "Try to attach current screenshot on events.\n" + - "This is an early-access feature and may not work on all platforms (it is explicitly disabled on WebGL).\n" + - "Additionally, the screenshot is captured mid-frame, when an event happens, so it may be incomplete.\n" + - "A screenshot might not be able to be attached, for example when the error happens on a background thread."), + "This is an early-access feature and may not work on all platforms (it is explicitly disabled on WebGL and in batch mode).\n" + + "The screenshot is taken at the end of the frame the event happens in. " + + "It is missing when the main thread is blocked, for example during an app hang."), options.AttachScreenshot); EditorGUI.indentLevel++; diff --git a/src/Sentry.Unity/SentryUnityOptions.cs b/src/Sentry.Unity/SentryUnityOptions.cs index 667f02300..2d81814d6 100644 --- a/src/Sentry.Unity/SentryUnityOptions.cs +++ b/src/Sentry.Unity/SentryUnityOptions.cs @@ -228,7 +228,8 @@ public sealed class SentryUnityOptions : SentryOptions public bool IosNativeSupportEnabled { get; set; } = true; /// - /// Whether the SDK should add native support for iOS + /// Whether the SDK should report watchdog terminations on iOS: the app getting killed by the operating system, + /// for example for using too much memory. This is disabled by default. /// public bool IosWatchdogTerminationIntegrationEnabled { get; set; } = false; From c7817763a97144c3dc1832af6d1828af281400dc Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Tue, 3 Nov 2026 17:46:17 +0100 Subject: [PATCH 2/6] Describe screenshot timing and the Org-Slug requirement precisely --- CHANGELOG.md | 2 +- src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs | 2 +- .../ConfigurationWindow/EnrichmentTab.cs | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e6d93deba..a0ecc4bde 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ### Fixes -- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs no Org-Slug, and `Scene Traces` has no Unity version requirement. (PR_LINK) +- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs the Org-Slug unless the auth token is an organization token, and `Scene Traces` has no Unity version requirement. (PR_LINK) ## 4.12.0 diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs index 3fa97546e..fe99e1692 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs @@ -206,7 +206,7 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti var errorIcon = EditorGUIUtility.IconContent("console.erroricon").image; var content = new GUIContent("The IL2CPP line number support relies on the Debug Symbol Upload to be enabled and configured." + - "\nAdditionally, this requires an Auth Token and the Project Name." + + "\nAdditionally, this requires an Auth Token and the Project Name, and the Org-Slug unless the token is an organization token." + "\nLearn more about how our IL2CPP support works in our docs.", errorIcon); EditorGUILayout.LabelField(content, EditorStyles.wordWrappedLabel); diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs index db8fcd2ee..ec25e5c24 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs @@ -32,9 +32,10 @@ internal static void Display(ScriptableSentryUnityOptions options) { options.AttachScreenshot = EditorGUILayout.BeginToggleGroup( new GUIContent("Attach Screenshots to Events", "Try to attach current screenshot on events.\n" + - "This is an early-access feature and may not work on all platforms (it is explicitly disabled on WebGL and in batch mode).\n" + - "The screenshot is taken at the end of the frame the event happens in. " + - "It is missing when the main thread is blocked, for example during an app hang."), + "This is an early-access feature and may not work on all platforms (it is explicitly disabled in the Editor, on WebGL and in batch mode).\n" + + "The screenshot is taken at the end of the current or next frame. " + + "It is missing when no frame completes within a second, for example while the main thread hangs " + + "or the app is paused in the background."), options.AttachScreenshot); EditorGUI.indentLevel++; From db67ec1360c8d7cc5e0abd5cdd3e1ba466fa0e34 Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Wed, 4 Nov 2026 12:20:31 +0100 Subject: [PATCH 3/6] Link the CHANGELOG entry to its PR --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a0ecc4bde..964f24c5b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ### Fixes -- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs the Org-Slug unless the auth token is an organization token, and `Scene Traces` has no Unity version requirement. (PR_LINK) +- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs the Org-Slug unless the auth token is an organization token, and `Scene Traces` has no Unity version requirement. ([#2933](https://github.com/getsentry/sentry-unity/pull/2933)) ## 4.12.0 From dd42d192d1fc4b91c11012cca2b34a46980ca403 Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Wed, 11 Nov 2026 10:02:37 +0100 Subject: [PATCH 4/6] Scope the screenshot timing to C# events and document when the Org Slug is required --- CHANGELOG.md | 2 +- .../ConfigurationWindow/AdvancedTab.cs | 2 +- .../ConfigurationWindow/DebugSymbolsTab.cs | 4 ++-- .../ConfigurationWindow/EnrichmentTab.cs | 9 +++++---- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 964f24c5b..b797233d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ### Fixes -- Corrected the tooltips, help boxes and option docs in the configuration window that described defaults or limitations wrongly: `Auto Set UserName` is disabled by default, `Attach Screenshots` works for events on background threads, the IL2CPP line number support needs the Org-Slug unless the auth token is an organization token, and `Scene Traces` has no Unity version requirement. ([#2933](https://github.com/getsentry/sentry-unity/pull/2933)) +- The configuration window's tooltips and help boxes and the option docs describe the SDK's defaults and requirements correctly: `Auto Set UserName` is disabled by default, `Attach Screenshots` also attaches screenshots to events on background threads, `Org Slug` is required unless the Auth Token is an organization token, `Scene Traces` has no Unity version requirement, and `IosWatchdogTerminationIntegrationEnabled` turns on reporting of watchdog terminations on iOS. ([#2933](https://github.com/getsentry/sentry-unity/pull/2933)) ## 4.12.0 diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs index fe99e1692..15efb1abd 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/AdvancedTab.cs @@ -206,7 +206,7 @@ internal static void Display(ScriptableSentryUnityOptions options, SentryCliOpti var errorIcon = EditorGUIUtility.IconContent("console.erroricon").image; var content = new GUIContent("The IL2CPP line number support relies on the Debug Symbol Upload to be enabled and configured." + - "\nAdditionally, this requires an Auth Token and the Project Name, and the Org-Slug unless the token is an organization token." + + "\nAdditionally, this requires an Auth Token and the Project Name, and the Org Slug unless the token is an organization token." + "\nLearn more about how our IL2CPP support works in our docs.", errorIcon); EditorGUILayout.LabelField(content, EditorStyles.wordWrappedLabel); diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/DebugSymbolsTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/DebugSymbolsTab.cs index a1d9dd38f..1a13b91c6 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/DebugSymbolsTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/DebugSymbolsTab.cs @@ -32,13 +32,13 @@ internal static void Display(SentryCliOptions cliOptions) new GUIContent( "Auth Token", cliOptions.UploadSymbols && string.IsNullOrWhiteSpace(cliOptions.Auth) ? SentryWindow.ErrorIcon : null, - "The authorization token from your user settings in Sentry"), + "The auth token sentry-cli uses to upload debug symbols, e.g. an organization token from your organization's settings in Sentry"), cliOptions.Auth); cliOptions.Organization = EditorGUILayout.TextField( new GUIContent( "Org Slug", - "The organization slug in Sentry"), + "The organization slug in Sentry. Required unless the Auth Token is an organization token."), cliOptions.Organization); cliOptions.Project = EditorGUILayout.TextField( diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs index ec25e5c24..2b3fa24e5 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs @@ -32,10 +32,11 @@ internal static void Display(ScriptableSentryUnityOptions options) { options.AttachScreenshot = EditorGUILayout.BeginToggleGroup( new GUIContent("Attach Screenshots to Events", "Try to attach current screenshot on events.\n" + - "This is an early-access feature and may not work on all platforms (it is explicitly disabled in the Editor, on WebGL and in batch mode).\n" + - "The screenshot is taken at the end of the current or next frame. " + - "It is missing when no frame completes within a second, for example while the main thread hangs " + - "or the app is paused in the background."), + "This is an early-access feature and may not work on all platforms (it is explicitly disabled on WebGL).\n" + + "For C# events, the screenshot is taken at the end of the current or next frame, and none is " + + "attached in the Editor or in batch mode. It is missing when no frame completes within a second, " + + "for example while the main thread hangs or the app is paused in the background.\n" + + "On Windows, native crashes get a screenshot taken by the native SDK when the crash happens."), options.AttachScreenshot); EditorGUI.indentLevel++; From 2becc926496dc05b0e2876e5ff447fd3a01ba8df Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Wed, 11 Nov 2026 10:06:21 +0100 Subject: [PATCH 5/6] Qualify the native crash screenshot note and align the CLI option labels --- src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs | 3 ++- src/Sentry.Unity.Editor/SentryCliOptionsEditor.cs | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs index 2b3fa24e5..fa88cc460 100644 --- a/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs +++ b/src/Sentry.Unity.Editor/ConfigurationWindow/EnrichmentTab.cs @@ -36,7 +36,8 @@ internal static void Display(ScriptableSentryUnityOptions options) "For C# events, the screenshot is taken at the end of the current or next frame, and none is " + "attached in the Editor or in batch mode. It is missing when no frame completes within a second, " + "for example while the main thread hangs or the app is paused in the background.\n" + - "On Windows, native crashes get a screenshot taken by the native SDK when the crash happens."), + "On Windows, with native support enabled, native crashes get a screenshot of the game's window, taken by the " + + "native SDK when the crash happens (not in batch mode or server builds)."), options.AttachScreenshot); EditorGUI.indentLevel++; diff --git a/src/Sentry.Unity.Editor/SentryCliOptionsEditor.cs b/src/Sentry.Unity.Editor/SentryCliOptionsEditor.cs index b3e47280e..25e4d4c47 100644 --- a/src/Sentry.Unity.Editor/SentryCliOptionsEditor.cs +++ b/src/Sentry.Unity.Editor/SentryCliOptionsEditor.cs @@ -16,8 +16,8 @@ public override void OnInspectorGUI() EditorGUILayout.Toggle("Enable Symbols Upload", cliOptions.UploadSymbols); EditorGUILayout.Toggle("Enable Dev Symbols Upload", cliOptions.UploadDevelopmentSymbols); - EditorGUILayout.TextField("Auth-Token", cliOptions.Auth); - EditorGUILayout.TextField("Org-Slug", cliOptions.Organization); + EditorGUILayout.TextField("Auth Token", cliOptions.Auth); + EditorGUILayout.TextField("Org Slug", cliOptions.Organization); EditorGUILayout.TextField("Project Name", cliOptions.Project); EditorGUILayout.LabelField("Options Configuration", EditorStyles.boldLabel); From ba4b5d2c95e3226927f05097b06007e52396b56f Mon Sep 17 00:00:00 2001 From: bitsandfoxes Date: Wed, 11 Nov 2026 11:48:00 +0100 Subject: [PATCH 6/6] Retrigger CI