feat (Unity): Updated options #12636
Open
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 1.34kB (0.01%) ⬆️. 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:
|
|
|
||
|  | ||
|
|
||
| The `Configure` callback gets invoked during the build process and allows you to modify the options used by Sentry CLI. |
There was a problem hiding this comment.
Is it worth clarifying a bit what is going on here? LIke we have a CLI, and it has options. But we also inlude the CLI in the SDK, and the options for it are configurable via the editor (right?) but also via C# code (what you already said below):
Suggested change
| The `Configure` callback gets invoked during the build process and allows you to modify the options used by Sentry CLI. | |
| While the options below describe the arguments accepted by [Sentry CLI](https://docs.sentry.io/cli/), the Sentry SDK for Unity includes the CLI within it. And exposes a way to configure it through the editor itself, as well as through code. The `Configure` callback gets invoked during the build process and allows you to modify the options used by Sentry CLI. |
docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| On mobile, the Unity SDK automatically modifies the generated Xcode and Gradle project to also contain the Cocoa and Java SDK respectively. These SDKs are capable of self-initializing before the Unity engine itself is started. This allows us to capture bugs/crashes of even the engine. | ||
|
|
||
| The options to enable self-initialization are accessible via `AndroidNativeInitializationType` and `IosNativeInitializationType`. They default to `NativeInitializationType.Runtime`. When set to `Buildtime`, the native SDKs are configured and set up during `build time` and initialize themselves before the Unity engine. This means, that these options are baked into the outputted projects and cannot be changed at runtime via C# code. Changes to i.e. `Release` and `Environment` will not apply to events generated by the native SDKs. If you need to change these options at runtime, consider keepting the initialization type to `runtime`. |
There was a problem hiding this comment.
They default to
NativeInitializationType.Runtime.
This concept wasn't introduced yet. how about right above this paragraph, having a two bullet points one for each value of They default to NativeInitializationType and describe what they do roughly. Then the paragraph is further explanation of the inner workkings?
|
|
||
| ## Migrating to 2.4.0 | ||
|
|
||
| ### Breaking Changes |
There was a problem hiding this comment.
Is it a breaking change on 2.4.0? I thought the old code worked fine, we just introduced some new way.
coolguyzone
reviewed
Feb 10, 2025
docs/platforms/unity/configuration/options/cli-options/index.mdx
Outdated
Show resolved
Hide resolved
coolguyzone
reviewed
Feb 10, 2025
docs/platforms/unity/configuration/options/cli-options/index.mdx
Outdated
Show resolved
Hide resolved
coolguyzone
reviewed
Feb 10, 2025
docs/platforms/unity/configuration/options/cli-options/index.mdx
Outdated
Show resolved
Hide resolved
coolguyzone
reviewed
Feb 10, 2025
docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx
Outdated
Show resolved
Hide resolved
coolguyzone
reviewed
Feb 10, 2025
|
|
||
| On mobile, the Unity SDK automatically modifies the generated Xcode and Gradle project to also contain the Cocoa and Java SDK respectively. These SDKs are capable of self-initializing before the Unity engine itself is started. This allows us to capture bugs/crashes of even the engine. | ||
|
|
||
| The options to enable self-initialization are accessible via `AndroidNativeInitializationType` and `IosNativeInitializationType`. They default to `NativeInitializationType.Runtime`. When set to `Buildtime`, the native SDKs are configured and set up during `build time` and initialize themselves before the Unity engine. This means, that these options are baked into the outputted projects and cannot be changed at runtime via C# code. Changes to i.e. `Release` and `Environment` will not apply to events generated by the native SDKs. If you need to change these options at runtime, consider keepting the initialization type to `runtime`. |
There was a problem hiding this comment.
Suggested change
| The options to enable self-initialization are accessible via `AndroidNativeInitializationType` and `IosNativeInitializationType`. They default to `NativeInitializationType.Runtime`. When set to `Buildtime`, the native SDKs are configured and set up during `build time` and initialize themselves before the Unity engine. This means, that these options are baked into the outputted projects and cannot be changed at runtime via C# code. Changes to i.e. `Release` and `Environment` will not apply to events generated by the native SDKs. If you need to change these options at runtime, consider keepting the initialization type to `runtime`. | |
| The options to enable self-initialization are accessible via `AndroidNativeInitializationType` and `IosNativeInitializationType`. They default to `NativeInitializationType.Runtime`. When set to `Buildtime`, the native SDKs are configured and set up during `build time` and initialize themselves before the Unity engine. This means that these options are baked into the outputted projects and cannot be changed at runtime via C# code. Changes to `Release` and `Environment` will not apply to events generated by the native SDKs. If you need to change these options at runtime, consider keepting the initialization type to `runtime`. |
coolguyzone
reviewed
Feb 10, 2025
coolguyzone
reviewed
Feb 10, 2025
coolguyzone
reviewed
Feb 10, 2025
coolguyzone
reviewed
Feb 10, 2025
|
|
||
| ### Breaking Changes | ||
|
|
||
| The Runtime- and BuildTime-Configuration have been merged into a single OptionsConfiguration script. This allows for programmatic configuration of the SDK in one place using precompile directives instead of having to duplicate setting options in two different files. |
There was a problem hiding this comment.
Suggested change
| The Runtime- and BuildTime-Configuration have been merged into a single OptionsConfiguration script. This allows for programmatic configuration of the SDK in one place using precompile directives instead of having to duplicate setting options in two different files. | |
| The Runtime- and BuildTime-Configuration have been merged into a single OptionsConfiguration script. This allows for programmatic configuration of the SDK in one place using precompiled directives instead of having to duplicate setting options in two different files. |
coolguyzone
approved these changes
Feb 10, 2025
Co-authored-by: Alex Krawiec <[email protected]> Co-authored-by: Bruno Garcia <[email protected]>
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.
This addresses the bigger changes introduced with
3.0.0and cleans up the documentation around Unity SDK's options and their programmatic configuration.RuntimeandBuildTimeConfigurationruntime initializationfor native SDKs now on all platforms3.0.0(and the missing2.4.0)Also fixes getsentry/sentry-unity#1795