Releases: getsentry/sentry-capacitor
3.0.0-rc.1
Sentry JavaScript V10
Version 10 of the Sentry JavaScript SDK primarily focuses on upgrading underlying OpenTelemetry dependencies to v2 with minimal breaking changes.
Version 10 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v9). Lower versions may continue to work, but may not support all features.
SDK Initialization changed for Sentry Vue and Nuxt
Instead of adding the Nuxt/Vue options into Sentry.init options, you will now have to add it inside siblingOptions, this only applies to parameters specific to the respective SDK, other SDKs like React or Angular won't have to do that:
before
Sentry.init({
app: app,
attachErrorHandler: false,
dsn: '...',
enableLogs: true,...
}, vueInit);after
Sentry.init({
dsn: '...',
enableLogs: true,
siblingOptions: {
vueOptions: {
app: app,
attachErrorHandler: false,
...
}
},
...
}, vueInit);Removed APIs
The changes outlined in this section detail deprecated APIs that are now removed.
* BaseClient was removed, use Client as a direct replacement.
* hasTracingEnabled was removed, use hasSpansEnabled as a direct replacement.
* The internal logger and type Logger exports in @sentry/core were removed, use debug and type SentryDebugLogger instead. This does not affect the logger export used for [Sentry Logging](https://docs.sentry.io/product/explore/logs/getting-started/).
* The _experiments.enableLogs and _experiments.beforeSendLog options were removed, use the top-level enableLogs and beforeSendLog options instead.
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: (log) => {
return log;
},
},
});
// after
Sentry.init({
enableLogs: true,
beforeSendLog: (log) => {
return log;
},
});Removed Options
_experimental.enableLogswas removed, please use the optionsenableLogsfromCapacitorOptions.
For more informations, please go to the following link: https://docs.sentry.io/platforms/javascript/migration/v9-to-v10
Sentry Cocoa V9
- With the addition of Sentry Cocoa V9, you may face issues when building your project, this is due to the increased minimum required version bump for the Apple platform, you can see the specific changes on the breaking change section.
PodSpec support
- The current version continues to support Podspec-based setup, however future major releases will support only Swift Package Manager (SPM). We recommend migrating your project to SPM to ensure a smooth transition to upcoming SDK versions.
Breaking Changes
Minimum Version Requirements
- iOS/macOS/tvOS:
- iOS 15.0+ (previously 11.0+)
- macOS 10.14+ (previously 10.13+)
- tvOS 15.0+ (previously 11.0+)
Features
- Add native attributes to logs (#1086)
- Add Replay ID to logs (#1086)
- Support for Capacitor 8 (#1071) - Special thanks to (jb3rndt).
- Add experimental Metric support for Web and iOS (#1055)
- Add Fallback to JavaScript SDK when Native SDK fails to initialize (#1043)
- Add spotlight integration
spotlightIntegration. (#1039)
Fixes
-
Disable Native Android Session Replay (#1105)
-
Duplicated session When running Capacitor as an app (#1088)
-
Added missing integrations
inboundFiltersIntegration,functionToStringIntegration,browserApiErrorsIntegration,breadcrumbsIntegration,globalHandlersIntegration,linkedErrorsIntegration,dedupeIntegrationandbrowserSessionIntegration(#1047)- This fixes the following option parameters that weren't working:
ignoreErrors,ignoreTransactions,allowUrls,denyUrls - For more information about the Integrations, check the following link: https://docs.sentry.io/platforms/javascript/configuration/integrations.
- This fixes the following option parameters that weren't working:
-
Breadcrumbs are now showing and are tied with native breadcrumbs too (#1047)
-
Init now showing the correct JSDoc for Vue/Nuxt init parameters. (#1046)
-
Replays/Logs/Sessions now have the
capacitorSDK name as the source of the event. (#1043) -
Sentry Capacitor integrations are now exposed to
@sentry/capacitor(#1039)
Dependencies
3.0.0-beta.3
3.0.0-beta.2
3.0.0-beta.1
Break Changes
Sentry JavaScript V10
Version 10 of the Sentry JavaScript SDK primarily focuses on upgrading underlying OpenTelemetry dependencies to v2 with minimal breaking changes.
Version 10 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v9). Lower versions may continue to work, but may not support all features.
Init changed for Sentry Vue and Nuxt
Instead of adding the Nuxt/Vue options into Sentry.init options, you will now have to add it inside siblingOptions, this only applies to parameters specific to the respective SDK, other SDKs like React or Angular won't have to do that:
before
Sentry.init({
app: app,
attachErrorHandler: false,
dsn: '...',
enableLogs: true,...
}, vueInit);after
Sentry.init({
dsn: '...',
enableLogs: true,
siblingOptions: {
vueOptions: {
app: app,
attachErrorHandler: false,
...
}
},
...
}, vueInit);Features
- Add experimental Metric support for Web and iOS (#1055)
- Add Fallback to JavaScript SDK when Native SDK fails to initialize (#1043)
- Add spotlight integration
spotlightIntegration. (#1039)
Fixes
-
Added missing integrations
inboundFiltersIntegration,functionToStringIntegration,browserApiErrorsIntegration,breadcrumbsIntegration,globalHandlersIntegration,linkedErrorsIntegration,dedupeIntegrationandbrowserSessionIntegration(#1047)- This fixes the following option parameters that weren't working:
ignoreErrors,ignoreTransactions,allowUrls,denyUrls - For more information about the Integrations, check the following link: https://docs.sentry.io/platforms/javascript/configuration/integrations.
- This fixes the following option parameters that weren't working:
-
Breadcrumbs are now showing and are tied with native breadcrumbs too (#1047)
-
Init now showing the correct JSDoc for Vue/Nuxt init parameters. (#1046)
-
Replays/Logs/Sessions now have the
capacitorSDK name as the source of the event. (#1043) -
Sentry Capacitor integrations are now exposed to
@sentry/capacitor(#1039)
Removed APIs
The changes outlined in this section detail deprecated APIs that are now removed.
* BaseClient was removed, use Client as a direct replacement.
* hasTracingEnabled was removed, use hasSpansEnabled as a direct replacement.
* The internal logger and type Logger exports in @sentry/core were removed, use debug and type SentryDebugLogger instead. This does not affect the logger export used for [Sentry Logging](https://docs.sentry.io/product/explore/logs/getting-started/).
* The _experiments.enableLogs and _experiments.beforeSendLog options were removed, use the top-level enableLogs and beforeSendLog options instead.
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: (log) => {
return log;
},
},
});
// after
Sentry.init({
enableLogs: true,
beforeSendLog: (log) => {
return log;
},
});Removed Options
_experimental.enableLogswas removed, please use the optionsenableLogsfromCapacitorOptions.
For more informations, please go to the following link: https://docs.sentry.io/platforms/javascript/migration/v9-to-v10
Dependencies
2.4.1
2.4.0
Update CHANGELOG.md (#1003)
2.3.1
2.3.0
2.2.0
Important Changes
- fix(browser): Ensure IP address is only inferred by Relay if
sendDefaultPiiistrue(#957)
This release includes a fix for a behaviour change
that was originally introduced with v9 of the JavaScript SDK: User IP Addresses should only be added to Sentry events automatically,
if sendDefaultPii was set to true.
However, the change in v9 required further internal adjustment, which should have been included in v10 of the SDK.
To avoid making a major bump, the fix was patched on the current version and not by bumping to V10.
There is no API breakage involved and hence it is safe to update.
However, after updating the SDK, events (errors, traces, replays, etc.) sent from the browser, will only include
user IP addresses, if you set sendDefaultPii: true in your Sentry.init options.
We apologize for any inconvenience caused!
Features
- Support for Swift Package Manager (#938)
Dependencies
2.1.0
Fixes
- TypeScript build with strict rules couldn't find BrowserTransportOptions type (#934)