Migration Guide

Migrating to 3.0.0

Changes to the initialization behaviour on iOS and Android

The native layer on mobile platforms (iOS and Android) no longer self-initializes before the Unity game engine starts. Previously, the SDK would use the options at build-time and bake them into the native layer. Instead, the SDK will now take the options passed into the Configure callback and use those to initialize the native SDKs. This allows users to modify the native SDK's options at runtime programmatically. The initialization behaviour is controlled by the IosNativeInitializationType and AndroidNativeInitializationType options.

To restore the previous behaviour, you can set the IosNativeInitializationType and AndroidNativeInitializationType options to BuildTime.

Changes to the programmatic configuration

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 preprocessor directives instead of having to duplicate setting options in two different files.

You can still use the old configuration classes, but they have been deprecated and will be removed in a future version. Going forward, you should use the new OptionsConfiguration script and make use of the preprocessor directives when setting options for different platforms.

Migrating to 0.28.0

Breaking Changes

The base classes for the Scriptable Objects used for programmatic configuration have been updated:

• Sentry.Unity.ScriptableOptionsConfiguration has been changed to SentryRuntimeOptionsConfiguration
• Sentry.Unity.Editor.ScriptableOptionsConfiguration has been changed to SentryBuildtimeOptionsConfiguration

If you make use of the programmatic configuration, you'll need to update your implementation with these base classes.

Migrating to 0.11.0

Programmatic Configuration Changes

You no longer need to to call SentryUnity.Init. Instead, you can let the SDK self-initialize and modify the options taken from the Sentry Unity editor configuration window by providing a ScriptableOptionsConfiguration object.

• Open the Sentry Unity editor configuration window.
• Go to the Options Config tab.
• Click Create options configuration.
  • This will prompt you to pick a location for your version of the scriptable options configuration script.
  • It will also create an instance of the ScriptableOptionsConfiguration and set in it the configuration window.
• Add your code to the newly created script.

Learn more in our options documentation.

Migrating From 0.7.0 or Earlier

Starting from version 0.7.0, the SDK is aliasing its dependencies. We do this to avoid creating conflicts with other packages. This also means that if you were relying on our dependencies for certain types like System.Text.Json, then you'll have to import them into your project yourself going forward.

Migrating From 0.3.0 or Earlier

The Sentry SDK deprecated the use of JSON files to store options and now uses scriptable objects instead. If you're migrating from version 0.3.0 or older, make sure to upgrade to version 0.15.0 first. It's the last version that supports options stored in JSON format. When you open the Sentry configuration editor window in version 0.15.0, your JSON file will be automatically converted into a scriptable object. This support will be dropped in version 0.16.0 and later.

Migrating From sentry.unity.lite to sentry.unity

1. Remove the old Sentry.cs and SentrySdk.cs files from your project.
2. Remove the old initialization code gameObject.AddComponent<SentrySdk>().Dsn = "___PUBLIC_DSN___";.
3. Install the new Sentry Unity SDK.
4. Calls to the API such as SentrySdk.CaptureMessage("Test event"); will continue to work and don't require any change.
5. Browse the documentation to learn more about the new capabilities of the SDK such as enriching events, tracing and configuration.