Migration Guide

This migration guide covers the migration from 4.x to 5.x as well as 5.x to 6.x, which is our current version.

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

Migrating from 5.x to 6.x

Migrating to the current version from 5.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:

  • Auto Session Tracking is enabled by default. This feature is collecting and sending health data about the usage of your application.
  • Attach stacktraces is enabled per default.
  • We bumped the minimum iOS version to 9.0.
  • Use a BOOL in SentryOptions instead of NSNumber to store booleans.
  • We had previously removed the enabled option from SentryOptions, but we brought it back in version 6.0.7 with slightly changed functionality. Previously setting an empty or incorrect DSN also set enabled to false. This side effect is removed. Setting the DSN has no impact on enabled. If the DSN is nil or empty or enabled is set to false and the client won't send any data to Sentry.

Breaking Changes

Store Endpoint

This version uses the envelope endpoint. If you are using self-hosted Sentry, you must use Sentry version >= v20.6.0 or higher. If you are using sentry.io, there is no impact. For this change, we also now cache events in envelopes on the disk. We decided not to migrate the few cached events from 5.x to 6.x into envelopes. Instead, we remove them from the disk. As a result, you might lose a few cached events when upgrading.

SDK Inits

We removed the deprecated SDK inits. The recommended way to initialize Sentry is now:

Copied
import Sentry

SentrySDK.start { options in
    options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0"
    // ...
}

Cleanup Public Headers

We cleaned up our public headers and made most of our classes private. If you can't access one of the classes you need please open an issue and tell us your use case so we can evaluates whether to either make the class public again or provide another API for you.

New type SentryId for eventId

In 5.x, we used a nullable NSString to represent an event ID. The SDK, Hub, and Client returned this nullable NSString for the event ID to capture messages, events, errors, and so forth. In 6.x, we have a new type SentryId, which is not nullable, to represent an event ID. Instead of returning nil when an event couldn't be queued for submission we return SentryId.empty.

Example in 5.x:

Copied
import Sentry

let eventId = SentrySDK.capture(message: "A message")
if (nil != eventId) {
    // event was queued for submission
} else {
    // event wasn't queued for submission
}

Example in 6.x:

Copied
import Sentry

let eventId = SentrySDK.capture(message: "A message")
if (eventId != SentryId.empty) {
    // event was queued for submission
} else {
    // event wasn't queued for submission
}

New type SentryMessage for Event.message

In 6.x, we introduce a new type SentryMessage for event.message. SentryMessage provides you the ability to pass a format string with parameters to Sentry, which can help group similar messages into the same issue.

Example in 5.x:

Copied
import Sentry

let event = Event()
event.message = "Hello World"

Example in 6.x:

Copied
import Sentry

let event = Event()
event.message = SentryMessage(formatted: "Hello World")

Make Scope nonnull for capture methods

In 5.x, you could pass a nullable scope to capture methods of the SDK, Hub, and Client, such as SentrySdk.captureMessage(). In 6.x, we changed the Scope to nonnull and provide overloads for the Hub and the Client.

Please see the Changelog for a complete list of changes.

Upgrading from 4.x to 5.x

The samples below illustrate how the SDK works:

Initialization

Example in 4.x:

Copied
do {
    Client.shared = try Client(dsn: "https://examplePublicKey@o0.ingest.sentry.io/0")
    try Client.shared?.startCrashHandler()
} catch let error {
    print("\(error)")
}

Example in 5.x:

Copied
SentrySDK.start(options: [
    "dsn": "https://examplePublicKey@o0.ingest.sentry.io/0",
    "debug": true
])

Add Breadcrumb

Example in 4.x:`

Copied
Client.shared?.breadcrumbs.add(Breadcrumb(level: .info, category: "test"))

Example in 5.x:

Copied
SentrySDK.addBreadcrumb(Breadcrumb(level: .info, category: "test"))

CaptureMessage with tags/environment/extra

Example in 4.x:

Copied
let event = Event(level: .debug)
event.message = "Test Message"
event.environment = "staging"
event.extra = ["ios": true]
Client.shared?.send(event: event)

Example in 5.x:

Copied
SentrySDK.capture(message: "Test Message") { (scope) in
    scope.setEnvironment("staging")
    scope.setExtras(["ios": true])
    let u = Sentry.User(userId: "1")
    u.email = "tony@example.com"
    scope.setUser(u)
}

setUser

Example in 4.x:

Copied
let u = User(userId: "1")
u.email = "tony@example.com"
Client.shared?.user = user

Example in 5.x:

Copied
let u = Sentry.User(userId: "1")
u.email = "tony@example.com"
SentrySDK.setUser(u)
You can edit this page on GitHub.