Crashlytics

The Crashlytics plugin lets you integrate out-of-the-box automatic crash reporting solution for iOS & Android into your Unreal Engine 4 project. Spend less time finding and more time fixing crashes. Named the #1 performance SDK on both iOS and Android, Crashlytics provides deep and actionable insights, even the exact line of code your app crashed on.

• Current version: 1.0.0
• Binaries compiled for: Unreal Engine 4.13
• Required Unreal Engine 4.13 or above.

Features

• Real-time crash reporting tool
• Information about the number of crashes and affected users
• Provides the exact line of code your app crashed on
• Notifications about crashes via e-mail
• Works with dev & shipping builds
• Out-of-the-box for iOS & Android
• Additional SDK included
• Works with Blueprint-only & source code projects
• Works with Launcher & GitHub UE4 versions

Blueprint nodes

Setup

1. Copy this folder to the Plugins folder located in the main path of your project.

   

2. Enable Crashlytics in Edit -> Plugins -> Misc -> Crashlytics.

   

3. Go to Edit -> Project Settings -> Crashlytics and set your Crashlytics API Key. You can obtain it on fabric.io

4. Paste the following code to field called Additional Plist Data in Project Settings -> IOS:

   <key>Fabric</key><dict><key>APIKey</key><string>[API_KEY]</string><key>Kits</key><array><dict><key>KitInfo</key><dict/><key>KitName</key><string>Crashlytics</string></dict></array></dict>

   and replace API_KEY with Crashlytics API Key.

5. Turn on Generate dSYM bundle for third party crash tools in Project Settings.

Uploading symbols

You need to upload symbols in order to properly handling crashes. You should do this after every submission to App Store or Google Play.

iOS

1. Find your Xcode project:

   a. If you are directly packaging on Mac, go to /[PATH_TO_PROJECT_ON_MAC]/Intermediate/ProjectFilesIOS/

   b. If you are packaging with remote connection from Windows to Mac, go to /Users/[USER_NAME]/UE4/Builds/[COMPUTER_NAME]/[PATH_TO_PROJECT_ON_WINDOWS]/Binaries/IOS/

2. Copy content from [PLUGIN_FOLDER]/Extras to path from previous point. Now you should have Crashlytics and Fabric folders in folder from previous point.

3. Run [PROJECT_NAME].xcodeproj or UE4_FromPC.xcodeproj

4. In the Project Navigator, click on your project and add a new run script build phase

5. Add following code to new run script build phase with replacing [API_KEY] and [BUILD_SECRET]

    ./Fabric/run [API_KEY] [BUILD_SECRET]
   

6. Build your project by clicking on Product -> Build

Android

1. Add new ant system variable.

2. Go to [PATH_TO_PROJECT]/Intermediate/Android/APK/

3. Open Command Prompt (Terminal) and run following command:

    ant crashlytics-symbols
   

Plugin icon designed by Freepik.