This quickstart describes how to set up Firebase Crashlytics in your app with the Firebase Crashlytics SDK, so you can get comprehensive crash reports in the Firebase console.
Before you begin
Optional: To get crash metrics such as crash-free users, breadcrumbs, and custom events, you'll need to enable Google Analytics in your Firebase project.
If your existing Firebase project doesn't have Google Analytics enabled, you can enable Google Analytics from the Integrations tab of your
. > Project settings
If you're creating a new Firebase project, enable Google Analytics during the project creation workflow.
Finally, in the Google Analytics console, enable data sharing in the Admin tab > Account Settings > Data Sharing Settings.
For older Firebase projects, note that you may need to enable data sharing in the Integrations tab of your
(in the Firebase console). > Project settings
Step 1: Set up Crashlytics in the Firebase console
Click Crashlytics in the left-hand nav panel of the Firebase console.
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.
Click Enable Crashlytics.
Step 2: Add the Firebase Crashlytics SDK to your app
Open the podfile you created for your Firebase project and add the
FirebaseCrashlyticspod. 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. Make sure you add Google Analytics Version 6.3.1 or later in order to get real time crash-free users and breadcrumbs.
pod 'Firebase/Crashlytics' # Recommended: Add the Firebase pod for Google Analytics pod 'Firebase/Analytics'
Install the pods, then re-open your
.xcworkspacefile to see the project in Xcode:
Import the Firebase module in your
FirebaseAppshared instance, typically in your app's
// Use the Firebase library to configure APIs. FirebaseApp.configure()
// Use the Firebase library to configure APIs. [FIRApp configure];
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.
Open your project in Xcode, then select its project file in the left navigator.
From the Select a project or target dropdown, select your main build target.
Select the Build Phases tab, then click> New Run Script Phase.
Expand the new Run Script section that appears. In the script field (located under the Shell field), add a new run script:
Add your app’s dSYM location as an input file that enables Crashlytics to automatically generate dSYMs for large apps more quickly. For example:
You can also provide your app's built
Info.plistlocation to the build phase's Input Files field:
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.
Step 5: Force a test crash to finish setup
To finish setting up Crashlytics and see initial data in the Crashlytics dashboard of the Firebase console, you need to force a test crash.
For details about how to do this, visit Test your implementation.
- Customize your crash report setup by adding opt-in reporting, logs, keys, and tracking of non-fatal errors.