Usage

You can capture errors with the captureError method. This method takes an Error object as a parameter. The Error object can be an NSError or a Swift.Error object.

import Sentry

do {
    try aMethodThatMightFail()
} catch {
    SentrySDK.capture(error: error)
}

Swift Errors

For Swift Errors conforming to the Error Protocol the SDK sends the domain, code and the description of the Swift error. For older versions of the SDK, prior to sentry-cocoa 8.7.0 the SDK only sends the domain and error code.

enum LoginError: Error {
    case wrongUser(id: String)
    case wrongPassword
}

SentrySDK.capture(error: LoginError.wrongUser("12345678"))

For the Swift error above Sentry displays:

Customizing Error Descriptions

This feature is available on sentry-cocoa 7.25.0 and above.

You may want to provide a custom description to make identifying the error in the Issues page easier. For NSError values, you can do this by adding a description to the userInfo dictionary with the key NSDebugDescriptionErrorKey.

Sentry will group errors based on the error domain and code, and by enum value for Swift enum types, so customizing error descriptions won’t impact grouping.

To customize the description for Swift Error types, you should conform to the CustomNSError protocol and return a user info dictionary:

enum MyCustomError: Error {
    case indexOutOfBounds
    case enumeratingWhileMutating
}

extension MyCustomError: CustomNSError {
    var errorUserInfo: [String : Any] {
        func getDebugDescription() -> String {
            switch self {
            case .indexOutOfBounds:
                return  "indexOutOfBounds"
            case .enumeratingWhileMutating:
                return "enumeratingWhileMutating"
            }
        }

        return [NSDebugDescriptionErrorKey: getDebugDescription()]
    }
}

Capturing Uncaught Exceptions in macOS

By default, macOS applications do not crash whenever an uncaught exception occurs. To enable this with Sentry:

1. Open the application's Info.plist file
2. Search for Principal class (the entry is expected to be NSApplication)
3. Replace NSApplication with SentryCrashExceptionApplication