README.md

Flurry Upload Clients

Flurry's Crash service can symbolicate the crashes reported by Flurry's SDK. This repository contains code to uploads the symbols required to properly symbolicate crashes from iOS apps and deobfuscate Android apps with ProGuard obfuscation. Both of these clients require programmatic access keys, these keys are NOT the same credentials that were previously used to access the apis from api.flurry.com.

How to send iOS symbols at build time

1. Ensure that your project is configured to build dSYM bundles

2. Copy the python script at xcode/upload-symbols.py to the root of your project directory

   Alternately, you can copy a Python 3.x version of the script from xcode/upload-symbols-py3.py. Note that this script requires Python 3, available at python.org or through Homebrew.

3. In XCode add a Run Script build phase

4. Add a configuration file in the root of your project flurry.config. Contents:

   [flurry]
   token=TOKEN
   api-key=API_KEY
   

5. Configure the build phase. You can find your API key in the Flurry Developer portal or in you AppDelegate

   ./upload-symbols.py -c flurry.config
   

   

Now whenever you build your application you will upload symbols to Flurry's symbolication service. If you wish you can configure your symbols to be sent only when you build an archive of your project; this is achieved by checking the _Run script only when installing` checkbox in the configuration.

How to send iOS symbols for a BitCode enabled app

The recommended approach is to use the Flurry Fastlane plugin.

If you choose not to use FastLane, this can be done manually through the following steps:

1. Download symbols from iTunesConnect
   • Go to iTunesConnect
   • Go to My Apps
   • Select the app you want symbols for
   • Inspect the current version
   • Open the build
   • Download the dsyms
2. Run the script using the -p <path to downloaded file> argument. eg.

./upload-symbols.py -c flurry.config -p ~/Downloads/dSYMs.zip

How to send ProGuard mapping files at build time

Note: If you have ProGuard enabled and you do not send your mapping file at build time then you must upload the generated mapping.txt file manually before any stack traces received from that version of your app can be deobfuscated.

1. Install Flurry SDK 6.7.0 or greater.
2. Apply the Flurry android crash plugin to your app's build

     buildscript {
      repositories {
       maven {
        url "https://plugins.gradle.org/m2/"
       }
       maven {
        url  "http://yahoo.bintray.com/maven"
       }
      }
      dependencies {
       classpath "gradle.plugin.com.flurry:symbol-upload:1.2.0"
      }
     }
     apply plugin: "com.flurry.android.symbols"
   

3. Configure the crash plugin by adding the following configuration to the build.gradle file.

   flurryCrash {
     apiKey ""
     token ""
   }
   

4. You may provide either configPath or apiKey and token
   • configPath "<the path to the flurry.config file described above>"
   • apiKey "<the api key used to initialize the SDK>"
   • token "<An environment variable to read the token from>"
   • useEnvironmentVariable (true|false) the default for useEnvironmentVariable is true. You can set it to false if you want to inline your Programmatic Token, though this is not recommended.
   • ndk (true|false) the default value is false. You can set it to true if you want to upload symbols for your native code as well.