How to Use Firebase Crashlytics API in Android Apps

Integrate Firebase Crashlytics

• Ensure your project is set up to use Firebase services by adding the google-services.json file in your project’s app/ directory.

 

• Ensure you have the required dependencies in your build.gradle files. Add Firebase Crashlytics to your app-level build.gradle file within the dependencies block:

  ```groovy
  implementation 'com.google.firebase:firebase-crashlytics:18.2.2'
  ```

 

• Don’t forget to apply the Google Services plugin at the bottom of your app-level build.gradle file:

  ```groovy
  apply plugin: 'com.google.gms.google-services'
  ```

 

Customize Crash Reporting

• To log non-fatal exceptions or specific events, use the following code in your Android app:

  ```kotlin
  try {
  // Some error-prone code
  } catch (e: Exception) {
  FirebaseCrashlytics.getInstance().recordException(e)
  }
  ```

 

• You can log custom events or messages that might help in debugging:

  ```kotlin
  FirebaseCrashlytics.getInstance().log("This is a custom log message.")
  ```

 

• Optionally, add user identifiers to Crashlytics to help distinguish between different user sessions:

  ```kotlin
  FirebaseCrashlytics.getInstance().setUserId("user123456")
  ```

 

Advanced Configuration

• Enable Crashlytics collection conditionally in your app by setting the following property:

  ```kotlin
  FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true) // or false
  ```
  This is useful when you want to control crash logging based on app environment or build type.

 

• You can add key-value pairs to Crashlytics logs for enriched contextual information:

  ```kotlin
  FirebaseCrashlytics.getInstance().setCustomKey("key", "value")
  ```

 

• For a more controlled deployment, set the Crashlytics distribution tool:

  ```groovy
  apply plugin: 'com.google.firebase.crashlytics'
  ```

  You can run:
  ```shell
  ./gradlew assembleRelease
  ```

 

Debugging and Monitoring

• Test Crashlytics on a debug build by forcing a crash:

  ```kotlin
  FirebaseCrashlytics.getInstance().crash()
  ```
  Deploy this on a test device and verify that crashes appear in the Firebase console.

 

• Review Crashlytics reports from the Firebase Console. They provide stack traces, logs, and detailed device information for crash events.