Git Product home page Git Product logo

upload-clients's Introduction

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 dSYM setting
  2. Copy the python script at xcode/upload-symbols.py to the root of your project directory
  3. In XCode add a Run Script build phase XCode build configuration
  4. Add a configuration file in the root of your project flurry.config. Contents:
[flurry]
token=TOKEN
api-key=API_KEY
  1. 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

Job configuration

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 Developer Account
  • Go to My Apps
  • Select the app you want symbols for
  • Inspect the current version Version select
  • Open the build Build select
  • Download the dsyms dSYMs download
  1. 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.
    // for alternate applications of the plugin 
    // see https://plugins.gradle.org/plugin/com.flurry.android.symbols
    plugins {
      id "com.flurry.android.symbols" version "1.1.0"
    }
    
    ...
    
    flurryCrash {
      <configuration>
    }
    
  3. Configure the crash plugin. 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.

upload-clients's People

Contributors

clayreimann avatar duseja2 avatar pandeyharsh avatar willmsn98 avatar jaysoffian avatar rollinsio avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.