Get started with Firebase Crashlytics using the Firebase Crashlytics SDK

This quickstart describes how to set up Firebase Crashlytics in your app for the first time using the Firebase Crashlytics SDK so you can get comprehensive crash reports in the Firebase console. Note that the SDK is currently in beta, so if you prefer to use a more stable version, you can set up Crashlytics using the legacy Fabric SDK instead.

Before you begin

Skip this step if your app already uses Firebase: First, add Firebase to your iOS project. Make sure to register your app and add a Firebase configuration file (you don't need to add any Firebase SDKs yet). If you don't have an iOS app, you can download a sample app.

Step 1: Set up Crashlytics in the Firebase console

  1. Click Crashlytics in the left-hand nav panel of the Firebase console.

  2. If your Firebase project has multiple apps registered in it, select the app you just added from the dropdown next to Crashlytics in the top bar of the console.

  3. Click Set up Crashlytics.

  4. Select This app is new to Crashlytics (it doesn't have any version of the SDK).

Step 2: Add Firebase Crashlytics to your app

  1. Open the podfile you created for your Firebase project and add the FirebaseCrashlytics pod. For an optimal experience with Firebase Crashlytics, we recommend enabling Google Analytics in your project by adding the Firebase pod for Analytics to your app as well.

    pod 'Firebase/Crashlytics'
    
    # Recommended: Add the Firebase pod for Google Analytics
    pod 'Firebase/Analytics'
    
  2. Install the pods, then re-open your .xcworkspace file to see the project in Xcode:

    pod install
    open your-project.xcworkspace
    
  3. Import the Firebase module in your UIApplicationDelegate:

    Swift

    import Firebase

    Objective-C

    @import Firebase;
  4. Configure a FirebaseApp shared instance, typically in your app's application:didFinishLaunchingWithOptions: method:

    Swift

      // Use the Firebase library to configure APIs.
      FirebaseApp.configure()
      

    Objective-C

      // Use the Firebase library to configure APIs.
      [FIRApp configure];
      
  5. Recompile your app.

Step 3: Initialize Crashlytics

You can initialize Crashlytics by adding a run script to your project’s build phase. The run script allows Xcode to automatically upload your project’s dSYM file whenever your app crashes so that Crashlytics can automatically generate crash reports.

  1. Open your project in Xcode, then select its project file in the left navigator.

  2. From the Select a project or target dropdown, select your main build target.

  3. Select the Build Phases tab, then click add > New Run Script Phase.

  4. Expand the new Run Script section that appears. In the script field (located under the Shell field), add a new run script:

    "${PODS_ROOT}/FirebaseCrashlytics/run"
  5. Xcode versions 10 or higher only: Add your app’s dSYM location as an input file that enables Crashlytics to automatically generate dSYMs for large apps more quickly. For example:

    ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}

    You can also provide your app's built Info.plist location to the build phase's Input Files field:

    $(SRCROOT)/$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)

After you add the SDK to your app, Crashlytics automatically gets to work listening for and collecting crash reports.

Step 4: Run your project

Finally, run your app. Your device logs display the Firebase verification that initialization is complete.

Next steps