macOS

Features:

• Multiple types of errors are captured, including:
  • Mach exceptions
  • Fatal signals
  • Unhandled exceptions
  • C++ exceptions
  • Objective-C exceptions
  • Error messages of fatalError, assert, and precondition
  • Start-up crashes. The SDK init waits synchronously for up to 5 seconds to flush out events if the app crashes within 2 seconds after the SDK init.
• Events enriched with device data
• Offline caching when a device is unable to connect; we send a report once we receive another event
• Breadcrumbs automatically captured for
  • Application lifecycle events (didBecomeActive, didEnterBackground)
  • Touch events
  • System events (battery level or state changed, memory warnings, device orientation changed, keyboard did show and did hide, screenshot taken)
  • Outgoing HTTP requests
• Release health tracks crash free users and sessions
• Attachments enrich your event by storing additional files, such as config or log files
• User Feedback provides the ability to collect user information when an event occurs
• Source Context shows snippets of code around the location of stack frames

On this page, we get you up and running with Sentry's SDK.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Install

Sentry captures data by using an SDK within your application’s runtime.

The minimum version for macOS is 10.10.

We recommend installing the SDK with Swift Package Manager (SPM), but we also support alternate installation methods. To integrate Sentry into your Xcode project, open your App in Xcode and open File > Add Packages. Then add the SDK by entering the git repo url in the top right search field:

https://github.com/getsentry/sentry-cocoa.git

Configure

Configuration should happen as early as possible in your application's lifecycle.

We recommend initializing the SDK on the main thread as soon as possible, such as in your AppDelegate application:didFinishLaunchingWithOptions method:

import Sentry // Make sure you import Sentry

// ....

func application(_ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    SentrySDK.start { options in
        options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0"
        options.debug = true // Enabled debug when first installing is always helpful
    }

    return true
}

When using SwiftUI and your app doesn't implement an app delegate, initialize the SDK within the App conformer's initializer:

import Sentry

@main
struct SwiftUIApp: App {
    init() {
        SentrySDK.start { options in
            options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0"
            options.debug = true // Enabled debug when first installing is always helpful

            // Enable tracing to capture 100% of transactions for performance monitoring.
            // Use 'options.tracesSampleRate' to set the sampling rate.
            // We recommend setting a sample rate in production.
            options.enableTracing = true
        }
    }
}

Experimental features

Want to play with some new features? Try out our experimental features for View Hierarchy, Time to Full Display (TTFD), MetricKit, Prewarmed App Start Tracing, Swift Async Stack Traces and App Launch Profiling. Experimental features are still a work-in-progress and may have bugs. We recognize the irony.

Let us know if you have feedback through GitHub issues.

import Sentry

SentrySDK.start { options in
    // ...

    // Enable all experimental features
    options.attachViewHierarchy = true
    options.enableMetricKit = true
    options.enableTimeToFullDisplayTracing = true
    options.swiftAsyncStacktraces = true
    options.enableAppLaunchProfiling = true
}

Stitch Together Swift Concurrency Stack Traces

If you use Swift concurrency, this feature will stitch your stack traces together. That means you will be able to see the full stack trace of your async code. For this to happen you need to enable the swiftAsyncStacktraces option. You can also enable this in your Objective-C project, however, only async code written in Swift will be stitched together.

import Sentry

SentrySDK.start { options in
    // ...
    options.swiftAsyncStacktraces = true
}

Use Sentry with SwiftUI

If you want to find out the performance of your Views in a SwiftUI project, try the SentrySwiftUI library.

Provide Debug Information

To capture crashes, you need to provide debug information to Sentry. You can also use our source context feature to display code snippets next to the event stack traces by enabling the include-sources option when uploading your debug information files. Debug information is provided by uploading dSYM files.

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

import Sentry

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

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.