Firebase Performance Monitoring is a free mobile app performance analytics service that helps you to gain insight into the performance characteristics of your app.

For more information about app performance and many other cool mobile services, check out Firebase.

Follow the instruction in the Root README to clone the repository.

Add the following lines to your ~/.bash_profile:

For Mac:

export ANDROID_HOME=~/Library/Android/sdk
export ANDROID_SDK_ROOT=~/Library/Android/sdk

For Linux:

export ANDROID_HOME=~/Android/Sdk
export ANDROID_SDK_ROOT=~/Android/Sdk

firebase-android-sdk$ git fetch origin main:main
firebase-android-sdk$ git checkout main

Build the SDK in firebase-android-sdk folder:

firebase-android-sdk$ ./gradlew :clean :firebase-perf:build --stacktrace

Please note that :clean and --stacktrace are optional. The build output will be generated in firebase-android-sdk/firebase-perf/build/outputs/aar.

firebase-android-sdk$ ./gradlew :clean :firebase-perf:test --stacktrace

firebase-android-sdk$ ./gradlew :clean :firebase-perf:testDebugUnitTest --tests "PackageName.ClassName.TestMethodName" --stacktrace

TestMethodName is optional, if not provided, all tests under PackageName.ClassName will be run. Similar mechanism applies to ClassName as well.

Follow the instructions here for the initial one time setup.

firebase-android-sdk$ ./gradlew :firebase-perf:connectedCheck

firebase-android-sdk$ ./gradlew :firebase-perf:deviceCheck

You can publish the SDK directly to your local maven repository like so:

./gradlew :firebase-perf:publishToMavenLocal

Add mavenLocal() to your project-level build.gradle file or settings.gradle file based on your app's set up.

Add implementation dependency to your module-level build.gradle file, with the version as defined in firebase-perf/gradle.properties.

apply plugin: 'com.android.application'

# Applies the 'perf-plugin'
apply plugin: 'com.google.firebase.firebase-perf'

.       .       .

dependencies {
   implementation 'com.google.firebase:firebase-perf:x.y.z'
}

See Reference for more details.

Generate code coverage:

firebase-android-sdk$ ./gradlew firebase-perf:checkCoverage --stacktrace

Open the report in:

firebase-android-sdk$ open firebase-perf/build/reports/jacoco/firebase-perf/html/com.google.firebase.perf/index.html

Checkout internal release guidelines at go/fireperf-android.