{"id":2346,"date":"2017-01-11T13:10:00","date_gmt":"2017-01-11T07:40:00","guid":{"rendered":"https:\/\/www.innovationm.com\/blog\/?p=2346"},"modified":"2023-01-20T18:55:57","modified_gmt":"2023-01-20T13:25:57","slug":"step-by-step-guide-on-firebase-crash-reporting","status":"publish","type":"post","link":"https:\/\/www.innovationm.com\/blog\/step-by-step-guide-on-firebase-crash-reporting\/","title":{"rendered":"Step-by-Step Guide on Firebase Crash Reporting"},"content":{"rendered":"

Objective<\/b>
\nTo get \u00a0complete<\/span> crash-report<\/span><\/i> whenever your app crashes. In Simple words, Firebase Crash Reporting will let you know the reason of crash \u00a0along with line number in your view controller or any class. <\/span><\/p>\n

\"firebase\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Prerequisite<\/b>
\nI\u2019m assuming you have a project, where you want to add Firebase Crash Reporting.<\/span><\/p>\n

First thing first, You need <\/span>Cocoapod<\/span><\/a> installed on your Mac and a working project (or, any iOS Single View Application).<\/span><\/p>\n

Step 1. <\/b>Login into your <\/span>Firebase Console<\/b><\/a><\/p>\n

\"screen-shot-2016-12-31-at-2-46-20-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

Click on <\/span>\u2018Create New Project\u2019<\/span><\/i> \u00a0and then pass on relevant information about your app (like, Your <\/span>App Name<\/span><\/i> and its <\/span>country<\/span><\/i>).<\/span><\/p>\n

\"screen-shot-2016-12-31-at-2-47-32-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 2. <\/b>Now, you are on <\/span>Firebase Dashboard<\/b><\/p>\n

\"screen-shot-2016-12-31-at-2-53-06-am\"<\/a><\/p>\n

As you can see there are several Firebase service, but we are quietly interested in <\/span>Firebase Crash Reporting<\/b><\/p>\n

\"screen-shot-2016-12-31-at-2-55-38-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

Next, they will ask you to choose your platform (<\/span>Obviously, it\u2019s iOS<\/b>)<\/span><\/p>\n

\"screen-shot-2016-12-31-at-2-57-24-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

When you get into it, there is form like window pops up.<\/span><\/p>\n

\"screen-shot-2016-12-31-at-3-02-58-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Where, you have to pass on <\/span>bundle id <\/b>of your app. Rest two are optional which you can ignore. <\/span><\/p>\n

So, From I can get my Bundle Id ?<\/span>
\nAnswer is, You have to move on to you app and select your <\/span>Project > General <\/b>and there you go <\/span>Bundle Identifier <\/b>under Identity section.<\/span><\/p>\n

\"screen-shot-2016-12-31-at-3-02-37-am\"<\/a><\/p>\n

 <\/p>\n

Say, I have <\/span>com.innovationm.FirebaseCrashReportingDemo <\/i><\/b>\u00a0<\/b>and it could be different (as, its Projects Dependent).<\/span><\/p>\n

Step 3.<\/b>
\nNow, you have to add <\/span>Google Services Info.plist<\/b> file which has all the credentials and private identifiers which Firebase will use for internal purpose (Doesn\u2019t make sense, still you have to add as Google Developer is asking you to do that \ud83d\ude00 ).<\/span><\/p>\n

\"screen-shot-2016-12-31-at-3-08-36-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

So, drap and drop the <\/span>GoogleService-Info.plist<\/b> in your xcode.<\/span><\/p>\n

Suggestion : <\/b>If your file name starts with <\/span>\u00a0GoogleService-Info(1).plist \u00a0<\/b>then, you should omit <\/span>(1) <\/b>from the file name. As, Firebase expects only <\/span>GoogleService-Info.plist <\/b>as its configuration file name. Else, it will cause confusion and pops you runtime error.<\/span><\/p>\n

Step 4.<\/b>
\nNow, they will ask you to install pod of Firebase Core (further, Firebase Crash). As, these are the dependencies which we need in this project.<\/span>
\nIn simple words, we are going to use <\/span>Firebase <\/b>so we need to integrate firebase framework (or, library) in your project. <\/span>
\nSo, Cocoapod will do it for us. <\/span><\/p>\n

\"screen-shot-2016-12-31-at-3-42-20-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Open <\/span>Terminal <\/b>(<\/span>CMD<\/span><\/i>+<\/span>Space<\/span><\/i> and type <\/span>Terminal<\/span><\/i>) \u00a0and type <\/span>cd [Path_Of_Your_Project] <\/b>and <\/span>return<\/span><\/i> key.<\/span>
\nThere is a shortcut to get the path of project directory.<\/span><\/p>\n

Tips : <\/b>Select your <\/span>Project Directory <\/span><\/i>in Finder and drag-drop to Terminal itself. It will give you the path of dropped directory.<\/span><\/p>\n

Step 4.1 :<\/b>
\ncd <\/span>[PATH_NAME]<\/b>
\n\"screen-shot-2016-12-31-at-4-04-22-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 4.2 :<\/b>
\nType <\/span>Pod init<\/b> and return key.<\/span>
\n\"screen-shot-2016-12-31-at-4-05-25-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 4.3 :<\/b>
\nThat makes a <\/span>Podfile <\/b>in root directory of your project.<\/span>
\n\"screen-shot-2016-12-31-at-4-05-58-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 4.4 : <\/b>And, Open it in any <\/span>Text Editor <\/b>(as, I\u2019m addict of <\/span>Sublime<\/span><\/i> so, I\u2019ll use it). And, paste the <\/span>pod file name <\/b>and save the file.<\/span>
\n\"screen-shot-2016-12-31-at-4-06-58-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Alert : <\/b>Make sure, you add these two lines in between Line 6 and 12 (as per image).<\/span><\/p>\n

Step 4.5 : <\/b>
\nType <\/span>pod install <\/b>and install the dependencies which you have mention. <\/span>
\n\"screen-shot-2016-12-31-at-4-36-39-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 4.6 : <\/b>
\nClose terminal and open your <\/span>.workspace <\/b>in your project directory.<\/span>
\n\"screen-shot-2016-12-31-at-4-21-10-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Alert : <\/b>If you open <\/span>.xcodeproj<\/b> file then you won’t get pod dependencies in your project. And, it will throw error that dependencies files are not found. <\/span><\/p>\n

Step 5.<\/b>
\nUltimately, we have a project which has Firebase Crash Reporting .<\/span>
\nNow, configure Firebase in <\/span>AppDelgate.swift<\/b>
\n\"screen-shot-2016-12-31-at-3-45-09-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

So, <\/span>AppDelegate.swift<\/b> is like<\/span>
\n\"screen-shot-2016-12-31-at-4-37-28-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Step 6.<\/b>
\nNext part is bit tricky, as we have to write a piece of script in <\/span>Build Phase<\/b>.<\/span>
\nFirst, go to your <\/span>Project Screen<\/b>.<\/span>
\n\"screen-shot-2016-12-31-at-4-40-25-am\"<\/a>And, choose <\/span>Build Phase <\/b>and click on + Button (just below <\/span>Capability<\/span><\/i>)<\/span><\/p>\n

\"screen-shot-2016-12-31-at-4-40-42-am\"<\/a>
\nThere you have options to choose. <\/span>
\n\"screen-shot-2016-12-31-at-4-42-54-am\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Next, we have a blank script screen with some <\/span>default <\/span><\/i>text.<\/span>
\n\"screen-shot-2016-12-31-at-4-43-06-am\"<\/a>So, we have to add these lines in script box.<\/p>\n

# Replace this with the GOOGLE_APP_ID from your GoogleService-Info.plist file\r\nGOOGLE_APP_ID=1:my:app:id\r\n\r\n# Replace the \/Path\/To\/ServiceAccount.json with the path to the key you just downloaded\r\n\"${PODS_ROOT}\"\/FirebaseCrash\/upload-sym \"\/Path\/To\/ServiceAccount.json\"<\/pre>\n
Though, we have to replace bold text i.e <\/span>GOOGLE_APP_ID<\/b> and <\/span>\/Path\/To\/ServiceAccount.json <\/b>with \u2018projects\u2019 value.<\/span><\/p>\n
First, we will get Google App Id from Info.plist which we have downloaded (i.e. <\/span>GoogleService-Info.plist<\/span><\/i>).<\/span>
\n\"screen-shot-2016-12-31-at-4-48-45-am\"<\/a><\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
And, Next we need<\/span> ServiceAccount JSON file<\/b> which we\u2019ll get it from Firebase Console.<\/span><\/p>\n
Click on <\/span>Setting <\/b>(Gear Button which is on right side of <\/span>OverView<\/b> Button)<\/span> > <\/b>\u00a0<\/span>Service Account (<\/b>last Tab<\/span>) > Crash Reporting > Generate Private Key <\/b>Button.<\/span>
\n\"screen-shot-2016-12-31-at-4-50-24-am\"<\/a>Download the file and rename whatever you want. Say, mine is <\/span>firebasecrashreport.json .<\/b><\/p>\n
And, paste in root folder of your project. After doing this, drag and drop it to xcode project.<\/span><\/p>\n
\"screen-shot-2016-12-31-at-4-53-31-am\"<\/a><\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
So, My Script would be like,<\/span><\/p>\n
# Replace this with the GOOGLE_APP_ID from your GoogleService-Info.plist file\r\n1:xxxxxxxxx:ios:xxxxxxxxxxx=1:my:app:id\r\n\r\n# Replace the \/Path\/To\/ServiceAccount.json with the path to the key you just downloaded\r\n\"${PODS_ROOT}\"\/FirebaseCrash\/upload-sym \"FirebaseCrashReportingDemo\/firebasecrashreport.json\"\r\n<\/pre>\n
FirebaseCrashReportingDemo<\/b> is the name of my project and respective to it <\/span>firebasecrashreport.json, <\/b>which makes my absolute path such.<\/span><\/p>\n
Congratulations, you\u2019re done with <\/span>Firebase Crash Reporting<\/b>. <\/span><\/p>\n
Step 7.<\/b>
\nTesting and Logging in Firebase Console.<\/span>
\nStep 7.1<\/b> : Add a line of statement which make a crash.<\/span><\/p>\n
fatalError() will do crash it for you.<\/pre>\n
\"1\"<\/a><\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
Step 7.2 : <\/b>Launch your app and it will crash. <\/span>
\nStep 7.3 :<\/b> Comment the crash Line. <\/span>
\nStep 7.4 :<\/b> Launch your App (It will send the log to Firebase Console).<\/span>
\nAfter 2-3 Minutes, it will log into Firebase Console.<\/span><\/p>\n
 \u00a0Initially, it will be like<\/span>
\n\"firebase\"<\/a><\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
Click on Error, and it will move you to Crash Reporting Panel.<\/span>
\n\"screen-shot-2016-12-31-at-5-16-14-am\"<\/a>It say, we are crashing at <\/span>line number 17 <\/b>for ViewController.swift screen.<\/span><\/p>\n
Is it true ?<\/span>
\n\"screen-shot-2016-12-31-at-5-16-45-am\"<\/a><\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
 <\/p>\n
Yes, we have a buggy code at line number 17 and that makes sense.<\/span>
\n\"screen-shot-2016-12-31-at-5-16-14-am\"<\/a>\"screen-shot-2016-12-31-at-5-32-36-am\"<\/a>Additional Feature<\/b><\/p>\n
You can send custom logs to Firebase console using <\/span>FIRCrashMessage<\/b>(\u201c<\/span>TYPE_YOUR_MESSAGE<\/span><\/i>\u201d) method.<\/span><\/p>\n
Further Reference<\/b><\/p>\n