upload-clients

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #android #macos #nodejs #windows #awesome #kubernetes #awesome-list #pytorch #security #ios

(★ 17)

No description available.

upload-clients Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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][programmatic-access], these keys are **NOT** the same credentials
that were previously used to access the apis from [api.flurry.com](api.flurry.com).

## How to send iOS symbols at build time

1. Ensure that your project is configured to build dSYM bundles
   ![dSYM setting](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/build-dsym-setting.png)
1. 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](https://www.python.org/downloads/mac-osx/) or through [Homebrew](https://brew.sh/).
1. In XCode add a `Run Script` build phase
   ![XCode build configuration](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/xcode-phases.png)
1. 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](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/job-config.png)

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](https://github.com/flurry/fastlane-plugin-flurry).

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](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/bitcode-connect.png)
   - Go to _My Apps_
   - Select the app you want symbols for
   - Inspect the current version
     ![Version select](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/bitcode-version.png)
   - Open the build
     ![Build select](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/bitcode-build.png)
   - Download the dsyms
     ![dSYMs download](https://raw.githubusercontent.com/flurry/upload-clients/master/instructions/bitcode-dsyms.png)
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.
1. Add the Flurry android crash plugin to your project's build.gradle file. Plugin can be found at: [https://plugins.gradle.org/plugin/com.flurry.android.symbols](https://plugins.gradle.org/plugin/com.flurry.android.symbols).
   ```
     buildscript {
      repositories {
       maven {
        url "https://plugins.gradle.org/m2/"
       }
      }
      dependencies {
       classpath "gradle.plugin.com.flurry:symbol-upload:8.0.0"
      }
     }
   ```
   The latest symbol upload plugin version is 8.0.0. 
1. Add the upload-client plugin in plugins section and the following configuration to the app build.gradle file.
   ```
   plugins {
      id: "com.flurry.android.symbols"
   }
   flurryCrash {
     apiKey ""
     token ""
   }
   ```
1. 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>"`
   - `useEnvVar (true|false)` the default for `useEnvVar` is `true`. You can set it to `false`
     if you want to inline your [Programmatic Token][programmatic-access], 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.
   - `uploadTimeout 12000` the minimum default timeout value is 60000ms or 1 minute but if you face build failures at uploadProguardMappingFilesRelease stage, try increasing the timeout

[programmatic-access]: https://developer.yahoo.com/flurry/docs/api/code/apptoken/
[plugin-install]: https://plugins.gradle.org/plugin/com.flurry.android.symbols

upload-clients

upload-clients Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

upload-clients

upload-clients Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README