iOS

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
  • App Hang Detection (not available for watchOS)
  • Watchdog Terminations
  • HTTP Client Errors
  • 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, viewDidAppear)
  • 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
• Automatic Performance Tracking
  • Rendering of UIViewControllers
  • Performance of HTTP requests
  • Distributed
    tracingThe process of logging the events that took place during a request, often across multiple services.
  • Mobile Vitals
    • Cold and warm start
    • Slow and frozen frames
  • Performance of file I/O operations
  • Performance of Core Data queries
  • User Interaction transactions for UI clicks
• 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
• Screenshot attachments for errors

The minimum version for iOS is 9.0.

We recommend installing the SDK with CocoaPods, but we also support alternate installation methods. To integrate Sentry into your Xcode project, specify it in your Podfile:

platform :ios, '11.0'
use_frameworks! # This is important

target 'YourApp' do
  pod 'Sentry', :git => 'https://github.com/getsentry/sentry-cocoa.git', :tag => '8.7.3'
end

Then run pod install.

You should also initialize the SDK 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
        }
    }
}

Experimental features

Want to play with some new features? Try out our experimental features for file I/O, Core Data, User Interaction Instrumentation, Screenshots. 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.enablePreWarmedAppStartTracing = true
    options.attachScreenshot = true
    options.attachViewHierarchy = true
    options.enableMetricKit = true
    options.swiftAsyncStacktraces = 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.