Ricevi rapporti sugli arresti anomali di Android NDK

Se la tua app Android contiene librerie native , puoi abilitare l'analisi completa dello stack e i rapporti dettagliati sugli arresti anomali per il tuo codice nativo da Firebase Crashlytics con alcuni piccoli aggiornamenti alla configurazione della build della tua app.

Questa guida descrive come configurare la segnalazione degli arresti anomali con Firebase Crashlytics SDK per NDK.

Se stai cercando come iniziare con Crashlytics nei tuoi progetti Unity, dai un'occhiata alla Guida introduttiva di Unity .

Prima di iniziare

1. Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android. Se non disponi di un'app per Android, puoi scaricare un'app di esempio .

2. Consigliato : per ottenere funzionalità come utenti senza arresti anomali, registri breadcrumb e avvisi sulla velocità, devi abilitare Google Analytics nel tuo progetto Firebase.

   • Se il tuo progetto Firebase esistente non ha Google Analytics abilitato, puoi abilitare Google Analytics dalla scheda Integrazioni delle tue settings > Impostazioni progetto nella console Firebase.

   • Se stai creando un nuovo progetto Firebase, abilita Google Analytics durante il flusso di lavoro di creazione del progetto.

Passaggio 1 : aggiungi Crashlytics SDK per NDK alla tua app

Per un'esperienza ottimale con Crashlytics, ti consigliamo di abilitare Google Analytics nel tuo progetto Firebase e di aggiungere l'SDK Firebase per Google Analytics alla tua 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'
}

Passaggio 2 : aggiungi il plug-in Crashlytics Gradle alla tua app

1. Nel tuo file Gradle a livello di root (a livello di progetto) ( <project>/build.gradle ), aggiungi il plug-in Crashlytics Gradle come dipendenza 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. Nel file Gradle del tuo modulo (a livello di app) (di solito <project>/<app-module>/build.gradle ), aggiungi il plug-in Crashlytics Gradle:

   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'
       ...
   }

Passaggio 3 : aggiungi l'estensione firebaseCrashlytics alla tua build

Nel file Gradle del modulo (a livello di app) (in genere app/build.gradle ), aggiungi l'estensione 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
          }
      }
  }
}

Passaggio 4 : imposta il caricamento automatico dei simboli nativi

Per produrre tracce di stack leggibili dagli arresti anomali di NDK, Crashlytics deve conoscere i simboli nei file binari nativi. Il plug-in Crashlytics Gradle include l'attività uploadCrashlyticsSymbolFile BUILD_VARIANT per automatizzare questo processo.

1. Per poter accedere all'attività per il caricamento automatico dei simboli, assicurati che nativeSymbolUploadEnabled sia impostato su true nel file Gradle del modulo (a livello di app).

2. Affinché i nomi dei metodi vengano visualizzati nelle analisi dello stack, è necessario richiamare in modo esplicito l'attività uploadCrashlyticsSymbolFile BUILD_VARIANT dopo ogni build della libreria NDK. Per esempio:

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT
   

3. Sia Crashlytics SDK for NDK che Crashlytics Gradle plugin dipendono dalla presenza dell'ID build GNU all'interno degli oggetti condivisi nativi.

   Puoi verificare la presenza di questo ID eseguendo readelf -n su ogni binario. Se l'ID build è assente, aggiungi -Wl,--build-id ai flag del tuo sistema di build per risolvere il problema.

Passaggio 5 : forza un arresto anomalo di prova per completare la configurazione

Per completare la configurazione di Crashlytics e visualizzare i dati iniziali nella dashboard di Crashlytics della console Firebase, devi forzare un arresto anomalo di prova.

1. Aggiungi codice alla tua app che puoi utilizzare per forzare un arresto anomalo del test.

   Puoi usare il codice seguente in MainActivity della tua app per aggiungere un pulsante alla tua app che, se premuto, provoca un arresto anomalo. Il pulsante è etichettato "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. Crea ed esegui la tua app.

3. Forza l'arresto anomalo del test per inviare il primo rapporto sull'arresto anomalo della tua app:

   1. Apri la tua app dal dispositivo o dall'emulatore di test.

   2. Nella tua app, premi il pulsante "Test Crash" che hai aggiunto utilizzando il codice sopra.

   3. Dopo l'arresto anomalo dell'app, riavviala in modo che l'app possa inviare il rapporto sull'arresto anomalo a Firebase.

4. Vai alla dashboard di Crashlytics della console Firebase per vedere il crash di prova.

   Se hai aggiornato la console e ancora non visualizzi l'arresto anomalo del test dopo cinque minuti, abilita la registrazione di debug per vedere se la tua app sta inviando rapporti sull'arresto anomalo.

E questo è tutto! Crashlytics sta ora monitorando la tua app per gli arresti anomali e puoi visualizzare e analizzare i rapporti e le statistiche sugli arresti anomali nella dashboard di Crashlytics.

Prossimi passi

• (Consigliato) Ottieni assistenza per il debug degli arresti anomali causati da errori della memoria nativa raccogliendo i rapporti GWP-ASan . Questi errori relativi alla memoria possono essere associati al danneggiamento della memoria all'interno dell'app, che è la causa principale delle vulnerabilità della sicurezza dell'app. Per sfruttare questa funzione, assicurati che la tua app abbia GWP-ASan esplicitamente abilitato e utilizzi l'ultimo Crashlytics SDK per NDK (v18.3.6+ o Firebase BoM v31.3.0+).

• Personalizza la configurazione del rapporto sugli arresti anomali aggiungendo rapporti di attivazione, registri, chiavi e tracciamento di errori non irreversibili.

• Integra con Google Play in modo da poter filtrare i rapporti sugli arresti anomali della tua app Android in base alla traccia di Google Play direttamente nella dashboard di Crashlytics. Ciò ti consente di focalizzare meglio la tua dashboard su build specifiche.

Risoluzione dei problemi

Se visualizzi tracce dello stack diverse nella console Firebase e nel logcat, fai riferimento alla Guida alla risoluzione dei problemi .

Opzioni alternative per il caricamento dei simboli

Il flusso di lavoro principale in questa pagina sopra è applicabile per build Gradle standard. Tuttavia, alcune app utilizzano una configurazione o strumenti diversi (ad esempio un processo di compilazione diverso da Gradle). In queste situazioni, le seguenti opzioni potrebbero essere utili per caricare correttamente i simboli.

Opzione : carica i simboli per i moduli della libreria e le dipendenze esterne

Questa opzione può essere utile nelle seguenti situazioni:

• Se utilizzi un processo di creazione NDK personalizzato all'interno di Gradle
• Se le tue librerie native sono integrate in un modulo libreria/funzionalità o fornite da terze parti
• Se l' attività di caricamento automatico dei simboli non riesce o se vengono visualizzati arresti anomali non simbolizzati nella dashboard

Opzione : carica simboli per build non Gradle o librerie native non rimosse inaccessibili

Questa opzione può essere utile nelle seguenti situazioni:

• Se usi un processo di compilazione diverso da Gradle

• Se le tue librerie native non spogliate ti vengono fornite in qualche modo in modo che non siano accessibili durante le build di Gradle