Files
react-native-firebase/docs/crashlytics/android.md
2019-10-01 17:24:45 +01:00

2.9 KiB

title, description
title description
Android Setup Manually integrate Crashlytics into your Android application.

Android Setup

If you're migrating from Fabric ensure you remove the fabric.properties file from your android project - if you do not do this you will not receive crash reports on the Firebase console.

Additional Installation Steps

Add Fabric Gradle Tools

These steps are required, if you do not add these your app will most likely crash at startup with the following Error: "The Crashlytics build ID is missing. This occurs when Crashlytics tooling is absent from your app's build configuration. Please review Crashlytics onboarding instructions and ensure you have a valid Crashlytics account."

Add the Fabric Maven repository

android/build.gradle:

// ..
buildscript {
  // ..
  repositories {
    // ..
    maven {
      url 'https://maven.fabric.io/public'
    }
  }
  // ..
}

Add the Fabric Tools Plugin dependency

android/build.gradle:

// ..
buildscript {
  // ..
  dependencies {
    // ..
    classpath 'io.fabric.tools:gradle:1.28.1'
  }
  // ..
}

Apply the Fabric Tools Plugin to your app

android/app/build.gradle:

apply plugin: 'com.android.application' // apply after this line
apply plugin: 'io.fabric'
// ..

Enable Crashlytics NDK reporting

OPTIONAL

Crashlytics NDK reporting allows you to capture Native Development Kit crashes, e.g. in React Native this will capture crashes originating from the Yoga layout engine.

android/app/build.gradle:

// ..
apply plugin: 'io.fabric'
// ..
crashlytics {
  enableNdk true
}

Android Manual Linking

The following steps are only required if your environment does not have access to React Native auto-linking.

Update Gradle Settings

Add the following to your projects /android/settings.gradle file:

include ':@react-native-firebase_crashlytics'
project(':@react-native-firebase_crashlytics').projectDir = new File(rootProject.projectDir, './../node_modules/@react-native-firebase/crashlytics/android')

Update Gradle Dependencies

Add the React Native Crashlytics module dependency to your /android/app/build.gradle file:

dependencies {
  ...
  implementation project(path: ":@react-native-firebase_crashlytics")
}

Add package to the Android Application

Import and apply the React Native Firebase module package to your /android/app/src/main/java/**/MainApplication.java file:

Import the package:

import io.invertase.firebase.crashlytics.ReactNativeFirebaseCrashlyticsPackage;

Add the package to the registry:

protected List<ReactPackage> getPackages() {
  return Arrays.asList(
    new MainReactPackage(),
    new ReactNativeFirebaseCrashlyticsPackage(),

Rebuild the project

Once the above steps have been completed, rebuild your Android project:

npx react-native run-android