Obtén informes de fallas del NDK de Android

Si tu app para Android contiene bibliotecas nativas, puedes habilitar los seguimientos de pila completa y los informes de fallas detallados para tu código nativo desde Firebase Crashlytics con solo hacer unas pequeñas actualizaciones en la configuración de compilación de tu app.

En esta guía, se describe cómo configurar los informes de fallas con el SDK de Firebase Crashlytics para el NDK.

Si quieres saber cómo comenzar a usar Crashlytics en tus proyectos de Unity, consulta la guía de introducción de Unity.

Antes de comenzar

1. Si aún no lo has hecho, agrega Firebase a tu proyecto de Android. Si no tienes ninguna app para Android, puedes descargar una app de ejemplo.

2. Recomendación: Para obtener funciones como usuarios que no experimentan fallas, registros de rutas de navegación y alertas de velocidad, debes habilitar Google Analytics en tu proyecto de Firebase.

   • Si el proyecto de Firebase actual no tiene habilitado Google Analytics, puedes hacerlo en la pestaña Integraciones de tu settings > Configuración del proyecto en Firebase console.

   • Si quieres crear un nuevo proyecto de Firebase, habilita Google Analytics durante el flujo de trabajo de creación.

Paso 1: Agrega el SDK de Crashlytics para el NDK a tu app

Para obtener una experiencia óptima con Crashlytics, recomendamos habilitar Google Analytics en tu proyecto de Firebase y agregar el SDK de Firebase para Google Analytics a la app.

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.1.0')

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics-ktx'
}

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.3.7'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.3.0'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.1.0')

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics'
}

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.3.7'
    implementation 'com.google.firebase:firebase-analytics:21.3.0'
}

Paso 2: Agrega el complemento de Gradle de Crashlytics a tu app

1. En el archivo de Gradle (<project>/build.gradle) de nivel de raíz (nivel de proyecto), agrega el complemento de Gradle de Crashlytics como una dependencia buildscript:

   buildscript {
       repositories {
         // Make sure that you have the following two repositories
         google()  // Google's Maven repository
         mavenCentral()  // Maven Central repository
       }
   
       dependencies {
           ...
           classpath 'com.android.tools.build:gradle:7.2.0'
   
           // Make sure that you have the Google services Gradle plugin dependency
           classpath 'com.google.gms:google-services:4.3.15'
   
           // Add the dependency for the Crashlytics Gradle plugin
           classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.5'
       }
   }

2. En el archivo Gradle (generalmente <project>/<app-module>/build.gradle) de tu módulo (nivel de app), agrega el complemento de Gradle de Crashlytics:

   plugins {
       id 'com.android.application'
   
       // Make sure that you have the Google services Gradle plugin
       id 'com.google.gms.google-services'
   
       // Add the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics'
       ...
   }

Paso 3: Agrega la extensión firebaseCrashlytics a tu compilación

En el archivo Gradle (generalmente app/build.gradle) del módulo (nivel de app), agrega la extensión firebaseCrashlytics.

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

Paso 4: Configura la carga automática de símbolos nativos

Para producir seguimientos de pila legibles de las fallas del NDK, Crashlytics debe conocer los símbolos de tus objetos binarios nativos. El complemento de Crashlytics para Gradle incluye la tarea uploadCrashlyticsSymbolFileBUILD_VARIANT a fin de automatizar el proceso.

1. A fin de que puedas acceder a la tarea para subir símbolos automáticamente, asegúrate de que nativeSymbolUploadEnabled esté configurado como true en el archivo Gradle de tu módulo (nivel de app).

2. Para que los nombres de los métodos aparezcan en los seguimientos de pila, debes invocar de manera explícita la tarea uploadCrashlyticsSymbolFileBUILD_VARIANT después de cada compilación de la biblioteca del NDK. Por ejemplo:

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT
   

3. El SDK de Crashlytics para el NDK y el complemento de Crashlytics para Gradle dependen de la presencia del ID de compilación de GNU dentro de los objetos compartidos nativos.

   Puedes verificar la presencia de este ID ejecutando readelf -n en cada objeto binario. Si no aparece el ID de compilación, agrega -Wl,--build-id a las marcas del sistema de compilación para solucionar el problema.

Paso 5: Fuerza una falla de prueba para finalizar la configuración

Para finalizar la configuración de Crashlytics y ver los datos iniciales en el panel de Crashlytics de Firebase console, debes forzar una falla de prueba.

1. Agrega código a tu app para forzar una falla de prueba.

   Puedes usar el siguiente código en la MainActivity de tu app para agregar un botón que, cuando se presione, genere una falla. El botón tiene la etiqueta “Test Crash”.

   Kotlin+KTX

   val crashButton = Button(this)
   crashButton.text = "Test Crash"
   crashButton.setOnClickListener {
      throw RuntimeException("Test Crash") // Force a crash
   }
   
   addContentView(crashButton, ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT))
   

   Java

   Button crashButton = new Button(this);
   crashButton.setText("Test Crash");
   crashButton.setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
          throw new RuntimeException("Test Crash"); // Force a crash
      }
   });
   
   addContentView(crashButton, new ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT));
   

2. Compila y ejecuta tu app.

3. Fuerza la falla de prueba para enviar el primer informe de fallas de la app, de la siguiente manera:

   1. Abre la app desde tu emulador o dispositivo de prueba.

   2. En tu app, presiona el botón “Test Crash” que agregaste con el código anterior.

   3. Una vez que tu app falle, reiníciala para que pueda enviar el informe de fallas a Firebase.

4. Ve al panel de Crashlytics en Firebase console para ver la falla de prueba.

   Si actualizaste la consola y sigues sin poder ver la falla de prueba después de cinco minutos, habilita el registro de depuración para confirmar si tu app está enviando informes de fallas.

Eso es todo. Crashlytics ahora supervisa la app para detectar fallas, y puedes ver e investigar informes y estadísticas de fallas en el panel de Crashlytics.

Próximos pasos

• (Recomendado) Obtén ayuda para recopilar informes de GWP-ASan con el propósito de depurar las fallas causadas por errores de la memoria nativa. Estos errores relacionados con la memoria se pueden asociar con la corrupción de la memoria dentro de tu app, lo que es la causa principal de las vulnerabilidades de seguridad de las apps. Para aprovechar esta función, asegúrate de que tu app tenga habilitado GWP-ASan de forma explícita y que use el SDK de Crashlytics para NDK (versión 18.3.6 o superior, o la BoM de Firebase versión 31.3.0 o superior).

• Agrega informes, registros y claves opcionales, así como seguimiento de errores recuperables para personalizar la configuración del informe de fallas.

• Realiza integraciones en Google Play a fin de poder filtrar los informes de fallas de tu app para Android por segmentos de Google Play directamente en el panel de Crashlytics. Esto te permite enfocar mejor el panel en compilaciones específicas.

Soluciona problemas

Si ves diferentes seguimientos de pila en Firebase console y en logcat, consulta la guía para solucionar problemas.

Alternativas para subir símbolos

El flujo de trabajo principal de esta página aplica a compilaciones estándar de Gradle. Sin embargo, algunas apps usan una configuración o herramientas diferentes (por ejemplo, un proceso de compilación distinto de Gradle). En estas situaciones, las siguientes opciones pueden ser útiles para subir símbolos correctamente.

Opción: Sube símbolos para módulos de biblioteca y dependencias externas

Esta opción puede ser útil en las siguientes situaciones:

• Si usas un proceso de compilación personalizado del NDK en Gradle.
• Si tus bibliotecas nativas se compilan en un módulo de biblioteca o de funciones o las proporciona un tercero.
• Si la tarea de carga de símbolos automática falla o ves fallas no simbolizadas en el panel.

Opción: Sube símbolos para compilaciones que no sean de Gradle o bibliotecas nativas inaccesibles no eliminadas

Esta opción puede ser útil en las siguientes situaciones:

• Si usas un proceso de compilación diferente de Gradle.

• Si se proporcionan tus bibliotecas nativas no eliminadas de alguna manera en la que no sean accesibles durante las compilaciones de Gradle.