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)
}

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

Customizing Error Descriptions

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

Sentry will display the error code in the error description field by default. For custom error types, you may want to provide a custom description to make it easier to identify the error in the Issues page. For NSError values, this can be done 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.

This can be particularly useful for Swift enum error types that conform to Error, where the error code can be hard to match with an enum case. 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()]
    }
}