Ricevi rapporti sugli arresti anomali di Android NDK

Se la tua app Android contiene librerie native , puoi abilitare le analisi dello stack completo e i report 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, consulta la 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 Android, puoi scaricare un'app di esempio .

  2. Consigliato : per ottenere automaticamente i log breadcrumb per comprendere le azioni degli utenti che portano a un arresto anomalo, un evento non fatale o ANR, 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 del tuo > 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

Nel file Gradle del modulo (a livello di app) (solitamente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi la dipendenza per Crashlytics NDK libreria per Android. Ti consigliamo di utilizzare la distinta base Android Firebase per controllare il controllo delle versioni della libreria.

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.7.3"))

    // 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")
}

Utilizzando la distinta base Firebase per Android , la tua app utilizzerà sempre le versioni compatibili delle librerie Firebase Android.

(Alternativa) Aggiungi le dipendenze della libreria Firebase senza utilizzare la distinta base

Se scegli di non utilizzare la distinta base Firebase, devi specificare ciascuna versione della libreria Firebase nella relativa riga di dipendenza.

Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la distinta base per gestire le versioni della libreria, il che garantisce che tutte le versioni siano compatibili.

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.6.2")
    implementation("com.google.firebase:firebase-analytics:21.5.1")
}
Cerchi un modulo di libreria specifico per Kotlin? A partire da ottobre 2023 (Firebase BoM 32.5.0) , sia gli sviluppatori Kotlin che quelli Java potranno dipendere dal modulo della libreria principale (per i dettagli, vedere le FAQ su questa iniziativa ).

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

  1. Nel file Gradle a livello di root (a livello di progetto) ( <project>/build.gradle.kts o <project>/build.gradle ), aggiungi il plug-in Crashlytics Gradle al blocco plugins :

    Kotlin

    plugins {
        id("com.android.application") version "7.3.0" apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin dependency
        id("com.google.gms.google-services") version "4.4.1" apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id("com.google.firebase.crashlytics") version "2.9.9" apply false
    }
    

    Groovy

    plugins {
        id 'com.android.application' version '7.3.0' apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin dependency
        id 'com.google.gms.google-services' version '4.4.1' apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id 'com.google.firebase.crashlytics' version '2.9.9' apply false
    }
    
  2. Nel file Gradle del modulo (a livello di app) (solitamente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi il plug-in Crashlytics Gradle:

    Kotlin

    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")
    }

    Groovy

    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 Crashlytics alla tua build

Nel file Gradle del modulo (a livello di app) (in genere <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), configura l'estensione Crashlytics.

Kotlin

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
  // ...
  buildTypes {
      getByName("release") {
          // Add this extension
          configure<CrashlyticsExtension> {
              // 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
          }
      }
  }
}

Groovy

// ...

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 analisi dello 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, devi richiamare esplicitamente l'attività uploadCrashlyticsSymbolFile BUILD_VARIANT dopo ogni build della libreria NDK. Per esempio:

    >./gradlew app:assembleBUILD_VARIANT\
               app:uploadCrashlyticsSymbolFileBUILD_VARIANT
    
  3. Sia Crashlytics SDK per NDK che il plugin Crashlytics Gradle dipendono dalla presenza dell'ID build GNU all'interno degli oggetti condivisi nativi.

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

Passaggio 5 : forza un arresto anomalo del test 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 del test.

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

    Puoi utilizzare il codice seguente nella 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 di prova o dall'emulatore.

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

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

  4. Vai alla dashboard Crashlytics della console Firebase per vedere l'arresto anomalo del test.

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


E questo è tutto! Crashlytics ora monitora gli arresti anomali della tua app e puoi visualizzare ed esaminare i rapporti e le statistiche sugli arresti anomali nel dashboard di Crashlytics.

Prossimi passi

  • (Consigliato) Ottieni assistenza per il debug degli arresti anomali causati da errori di memoria nativa raccogliendo report 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 funzionalità di debug, 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, registri, chiavi e monitoraggio degli errori non fatali.

  • Integra con Google Play in modo da poter filtrare i rapporti sugli arresti anomali della tua app Android in base al monitoraggio 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 analisi dello stack diverse nella console Firebase e nel logcat, fai riferimento alla guida alla risoluzione dei problemi .



Opzioni alternative per caricare i simboli

Il flusso di lavoro principale in questa pagina sopra è applicabile alle 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 simboli per moduli di libreria e 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 vengono visualizzati arresti anomali non simbolici nella dashboard

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

Questa opzione può essere utile nelle seguenti situazioni:

  • Se usi un processo di compilazione diverso da Gradle

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