Skip to content

feat(apple): Migration guide for sentry-cocoa 7 -> 8 #5939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philipphofmann merged 10 commits into from
Jan 10, 2023
Merged

feat(apple): Migration guide for sentry-cocoa 7 -> 8 #5939

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f4c1542
Migration guide for 7 -> 8
kevinrenskers Dec 9, 2022
0028a8a
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
3ae66a7
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
a68f134
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
a25581f
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
36bd399
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
408b7d0
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
0d8f546
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 9, 2022
352ae63
Style changes
kevinrenskers Dec 9, 2022
fc189e1
Update src/platforms/apple/common/migration.mdx
kevinrenskers Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 65 additions & 5 deletions src/platforms/apple/common/migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,68 @@ title: Migration Guide
sidebar_order: 1000
---

To upgrade from the 4.x version of the SDK to the 7.x version of the SDK, you must first migrate from 4.x to 5.x, then 5.x to 6.x and finally from 6.x to 7.x.
To upgrade from version 4.x of the SDK to version 8.x of the SDK, you must first migrate from 4.x to 5.x, then 5.x to 6.x, then 6.x to 7.x, and finally from 7.x to 8.x.

## Migrating from 6.x to 7.x
## Migrating From 7.x to 8.x

Migrating to 8.x from 7.x includes a few breaking changes. We provide this guide to help you to update your SDK.

### Configuration Changes

This version includes the following configuration changes:

- Rename `SentryOptions.enableAutoPerformanceTracking` to `SentryOptions.enableAutoPerformanceTracing`
- Rename `SentryOptions.enableUIViewControllerTracking` to `SentryOptions.enableUIViewControllerTracing`
- Rename `SentryOptions.enablePreWarmedAppStartTracking` to `SentryOptions.enablePreWarmedAppStartTracing`
- Rename `SentryOptions.enableFileIOTracking` to `SentryOptions.enableFileIOTracing`
- Rename `SentryOptions.enableCoreDataTracking` to `SentryOptions.enableCoreDataTracing`
- Rename `SentryOptions.enableOutOfMemoryTracking` to `SentryOptions.enableWatchdogTerminationsTracking`

### Breaking Changes

#### SDK Inits

We removed the version of `SentrySDK.startWithOptions` that took a dictionary, and renamed `SentrySDK.startWithOptionsObject` to `SentrySDK.startWithOptions`. The recommended way to initialize Sentry has not changed:

```swift {tabTitle:Swift}
import Sentry

SentrySDK.start { options in
options.dsn = "___PUBLIC_DSN___"
// ...
}
```

```objective-c
@import Sentry;

[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
options.dsn = @"___PUBLIC_DSN___";
// ...
}];
```

#### Swift API Improvements

We made some changes to make the API more ergonomic in Swift:

- Rename `SentrySDK.addBreadcrumb(crumb:)` to `SentrySDK.addBreadcrumb(_ crumb:)`
- Rename `SentryScope.add(_ crumb:)` to `SentryScope.addBreadcrumb(_ crumb:)`
- Rename `SentryScope.add(_ attachment:)` to `SentryScope.addAttachment(_ attachment:)`
- Rename `Client` to `SentryClient`

#### Default Integrations

- The user interaction tracing integration is now enabled by default.
- The File I/O tracing integration is now enabled by default.
Comment on lines +58 to +59

@philipphofmann philipphofmann Dec 12, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could link to the features here.


#### Changes to Minimum OS Versions and Xcode

The minimum supported OS versions have been bumped to macOS 10.13, iOS 11, tvOS 11, and watchOS 4.

The minimum Xcode version has been bumped to 13.

## Migrating From 6.x to 7.x

<Alert level="info" title="Important">

Expand Down Expand Up @@ -52,8 +111,8 @@ on `SentryOptions` to align with other Sentry SDKs, and set the default `diagnos
`SentryLevel.debug`. Furthermore, we removed setting the `logLevel` statically on the `SentrySDK`.
Please use the `SentryOptions` to set the `diagnosticLevel` instead.


6.x

```swift
SentrySDK.start { options in
options.logLevel = SentryLogLevel.verbose
Expand All @@ -65,13 +124,14 @@ SentrySDK.logLevel = SentryLogLevel.verbose
```

7.x

```swift
SentrySDK.start { options in
options.diagnosticLevel = SentryLevel.debug
}
```

## Migrating from 5.x to 6.x
## Migrating From 5.x to 6.x

Migrating to 6.x from 5.x includes a few breaking changes. We provide this guide to help you to update your SDK.

Expand Down Expand Up @@ -212,7 +272,7 @@ In 5.x, you could pass a nullable scope to capture methods of the SDK, Hub, and

Please see the [Changelog](https://github.com/getsentry/sentry-cocoa/blob/master/CHANGELOG.md) for a complete list of changes.

## Upgrading from 4.x to 5.x
## Upgrading From 4.x to 5.x

The samples below illustrate how the SDK works:

Expand Down