Wenn Ihre Android-App native Bibliotheken enthält, können Sie mit ein paar kleinen Aktualisierungen der Build-Konfiguration Ihrer App vollständige Stack-Traces und detaillierte Absturzberichte für Ihren nativen Code von Firebase Crashlytics aktivieren.
In dieser Anleitung wird beschrieben, wie Sie Absturzberichte mit dem Firebase Crashlytics SDK für NDK konfigurieren.
Wenn Sie erfahren möchten, wie Sie mit Crashlytics in Ihren Unity-Projekten beginnen können, schauen Sie sich den Unity-Leitfaden „Erste Schritte“ an.
Bevor Sie beginnen
Wenn Sie dies noch nicht getan haben, fügen Sie Firebase zu Ihrem Android-Projekt hinzu. Wenn Sie keine Android-App haben, können Sie eine Beispiel-App herunterladen.
Empfohlen : Um Funktionen wie absturzfreie Benutzer, Breadcrumb-Protokolle und Geschwindigkeitswarnungen zu erhalten, müssen Sie Google Analytics in Ihrem Firebase-Projekt aktivieren.
Wenn in Ihrem bestehenden Firebase-Projekt Google Analytics nicht aktiviert ist, können Sie Google Analytics über die Registerkarte „Integrationen“ Ihres Projekts aktivieren
Wenn Sie ein neues Firebase-Projekt erstellen, aktivieren Sie Google Analytics während des Projekterstellungsworkflows.
Schritt 1 : Fügen Sie das Crashlytics SDK für NDK zu Ihrer App hinzu
Fügen Sie in Ihrer Modul-Gradle-Datei (auf App-Ebene) (normalerweise<project>/<app-module>/build.gradle.kts
oder <project>/<app-module>/build.gradle
) die Abhängigkeit für das Crashlytics NDK hinzu Bibliothek für Android. Wir empfehlen die Verwendung der Firebase Android BoM zur Steuerung der Bibliotheksversionierung.Für ein optimales Erlebnis mit Crashlytics empfehlen wir, Google Analytics in Ihrem Firebase-Projekt zu aktivieren und das Firebase SDK für Google Analytics zu Ihrer App hinzuzufügen.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:32.6.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") }
Durch die Verwendung der Firebase Android BoM verwendet Ihre App immer kompatible Versionen der Firebase Android-Bibliotheken.
(Alternative) Fügen Sie Firebase-Bibliotheksabhängigkeiten hinzu , ohne die Stückliste zu verwenden
Wenn Sie die Firebase-Stückliste nicht verwenden möchten, müssen Sie jede Firebase-Bibliotheksversion in ihrer Abhängigkeitszeile angeben.
Beachten Sie: Wenn Sie mehrere Firebase-Bibliotheken in Ihrer App verwenden, empfehlen wir dringend, die BoM zum Verwalten der Bibliotheksversionen zu verwenden, um sicherzustellen, dass alle Versionen kompatibel sind.
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.0") implementation("com.google.firebase:firebase-analytics:21.5.0") }
Schritt 2 : Fügen Sie das Crashlytics Gradle-Plugin zu Ihrer App hinzu
Fügen Sie in Ihrer Gradle-Datei auf Stammebene (Projektebene) (
<project>/build.gradle.kts
oder<project>/build.gradle
) das Crashlytics Gradle-Plugin zumplugins
Block hinzu: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.0" 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.0' apply false // Add the dependency for the Crashlytics Gradle plugin id 'com.google.firebase.crashlytics' version '2.9.9' apply false }
Fügen Sie in Ihrer Modul-Gradle-Datei (auf App-Ebene) (normalerweise
<project>/<app-module>/build.gradle.kts
oder<project>/<app-module>/build.gradle
) das Crashlytics Gradle-Plugin hinzu: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' }
Schritt 3 : Fügen Sie die Crashlytics-Erweiterung zu Ihrem Build hinzu
Konfigurieren Sie in der Gradle-Datei Ihres Moduls (App-Ebene) (normalerweise <project>/<app-module>/build.gradle.kts
oder <project>/<app-module>/build.gradle
) die Crashlytics-Erweiterung.
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 } } } }
Schritt 4 : Richten Sie das automatische Hochladen nativer Symbole ein
Um lesbare Stack-Traces von NDK-Abstürzen zu erstellen, muss Crashlytics die Symbole in Ihren nativen Binärdateien kennen. Das Crashlytics Gradle-Plugin enthält die Aufgabe uploadCrashlyticsSymbolFile BUILD_VARIANT
um diesen Prozess zu automatisieren.
Damit Sie auf die Aufgabe zum automatischen Hochladen von Symbolen zugreifen können, stellen Sie sicher, dass
nativeSymbolUploadEnabled
in der Gradle-Datei Ihres Moduls (App-Ebene) auf „true
gesetzt ist.Damit Methodennamen in Ihren Stack-Traces angezeigt werden, müssen Sie die Aufgabe
uploadCrashlyticsSymbolFile BUILD_VARIANT
nach jedem Build Ihrer NDK-Bibliothek explizit aufrufen. Zum Beispiel:>./gradlew app:assembleBUILD_VARIANT\ app:uploadCrashlyticsSymbolFileBUILD_VARIANT
Sowohl das Crashlytics SDK für NDK als auch das Crashlytics Gradle-Plugin hängen vom Vorhandensein der GNU-Build-ID in den nativen freigegebenen Objekten ab.
Sie können das Vorhandensein dieser ID überprüfen, indem Sie ausführen
readelf -n
für jede Binärdatei. Wenn die Build-ID fehlt, fügen Sie hinzu-Wl,--build-id
zu den Flags Ihres Build-Systems hinzufügen, um das Problem zu beheben.
Schritt 5 : Erzwingen Sie einen Testabsturz, um die Einrichtung abzuschließen
Um die Einrichtung von Crashlytics abzuschließen und erste Daten im Crashlytics-Dashboard der Firebase-Konsole anzuzeigen, müssen Sie einen Testabsturz erzwingen.
Fügen Sie Ihrer App Code hinzu, mit dem Sie einen Testabsturz erzwingen können.
Sie können den folgenden Code in
MainActivity
Ihrer App verwenden, um Ihrer App eine Schaltfläche hinzuzufügen, die beim Drücken einen Absturz verursacht. Die Schaltfläche ist mit „Test Crash“ beschriftet.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));
Erstellen Sie Ihre App und führen Sie sie aus.
Erzwingen Sie den Testabsturz, um den ersten Absturzbericht Ihrer App zu senden:
Öffnen Sie Ihre App von Ihrem Testgerät oder Emulator.
Klicken Sie in Ihrer App auf die Schaltfläche „Absturz testen“, die Sie mit dem obigen Code hinzugefügt haben.
Nachdem Ihre App abgestürzt ist, starten Sie sie neu, damit Ihre App den Absturzbericht an Firebase senden kann.
Gehen Sie zum Crashlytics-Dashboard der Firebase-Konsole, um Ihren Testabsturz zu sehen.
Wenn Sie die Konsole aktualisiert haben und der Testabsturz nach fünf Minuten immer noch nicht auftritt, aktivieren Sie die Debug-Protokollierung , um zu sehen, ob Ihre App Absturzberichte sendet.
Und das ist es! Crashlytics überwacht Ihre App jetzt auf Abstürze und Sie können Absturzberichte und -statistiken im Crashlytics-Dashboard anzeigen und untersuchen.
Nächste Schritte
(Empfohlen) Erhalten Sie Hilfe beim Debuggen von Abstürzen, die durch native Speicherfehler verursacht werden, indem Sie GWP-ASan-Berichte sammeln . Diese speicherbezogenen Fehler können mit einer Speicherbeschädigung in Ihrer App verbunden sein, die die Hauptursache für Sicherheitslücken in der App darstellt. Um diese Debugging-Funktion nutzen zu können, stellen Sie sicher, dass für Ihre App GWP-ASan explizit aktiviert ist und das neueste Crashlytics SDK für NDK (v18.3.6+ oder Firebase BoM v31.3.0+) verwendet.
Passen Sie die Einrichtung Ihres Absturzberichts an , indem Sie optionale Berichte, Protokolle, Schlüssel und die Verfolgung nicht schwerwiegender Fehler hinzufügen.
Integrieren Sie Google Play, sodass Sie die Absturzberichte Ihrer Android-App direkt im Crashlytics-Dashboard nach Google Play-Track filtern können. Dadurch können Sie Ihr Dashboard besser auf bestimmte Builds konzentrieren.
Fehlerbehebung
Wenn Sie in der Firebase-Konsole und im Logcat unterschiedliche Stack-Traces sehen, lesen Sie die Anleitung zur Fehlerbehebung .
Alternative Möglichkeiten zum Hochladen von Symbolen
Der Hauptworkflow auf dieser Seite oben gilt für Standard-Gradle-Builds. Einige Apps verwenden jedoch eine andere Konfiguration oder andere Tools (z. B. einen anderen Build-Prozess als Gradle). In diesen Situationen können die folgenden Optionen für das erfolgreiche Hochladen von Symbolen hilfreich sein.
Option : Symbole für Bibliotheksmodule und externe Abhängigkeiten hochladen
Diese Option kann in den folgenden Situationen hilfreich sein:
- Wenn Sie einen benutzerdefinierten NDK-Build-Prozess in Gradle verwenden
- Wenn Ihre nativen Bibliotheken in einem Bibliotheks-/Funktionsmodul integriert sind oder von einem Drittanbieter bereitgestellt werden
- Wenn die Aufgabe zum automatischen Hochladen von Symbolen fehlschlägt oder im Dashboard nicht symbolisierte Abstürze angezeigt werden
Bei der Standardaufgabe zum Hochladen von Crashlytics-Symbolen wird davon ausgegangen, dass Sie Ihre nativen Bibliotheken als Teil des Gradle-Builds Ihres App-Moduls erstellen und dabei standardmäßige NDK-Build-Tools wie CMake verwenden.
Wenn Sie jedoch einen angepassten NDK-Build-Prozess in Gradle verwenden oder Ihre nativen Bibliotheken in einem Bibliotheks-/Feature-Modul erstellt oder von einem Drittanbieter bereitgestellt werden, müssen Sie möglicherweise explizit den Pfad zu Ihren nicht entfernten Bibliotheken angeben. Um dies zu erreichen, können Sie die Eigenschaft unstrippedNativeLibsDir
innerhalb der Crashlytics-Erweiterung in Ihrer Gradle-Build-Datei hinzufügen.
Stellen Sie sicher, dass Sie die folgenden ersten Aufgaben des Hauptworkflows weiter oben auf dieser Seite abgeschlossen haben:
Damit die Aufgabe zum automatischen Hochladen von Symbolen Ihre Symbolinformationen finden kann, fügen Sie Folgendes zu Ihrer Modul-Gradle-Datei (auf App-Ebene) hinzu (normalerweise
<project>/<app-module>/build.gradle.kts
oder<project>/<app-module>/build.gradle
):Kotlin
import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension // ... android { // ... buildTypes { release { configure
{ nativeSymbolUploadEnabled = true unstrippedNativeLibsDir = file("PATH/TO/UNSTRIPPED/DIRECTORY") } } } } Groovy
// ... android { // ... buildTypes { release { firebaseCrashlytics { nativeSymbolUploadEnabled true unstrippedNativeLibsDir file("PATH/TO/UNSTRIPPED/DIRECTORY") } } } }
Das Crashlytics-Plugin durchsucht das angegebene Verzeichnis rekursiv nach nativen Bibliotheken mit der Erweiterung
.so
. Crashlytics extrahiert dann Debugging-Symbole aus all diesen Bibliotheken und lädt sie auf die Firebase-Server hoch.Folgendes können Sie in der Eigenschaft
unstrippedNativeLibsDir
angeben:Jedes für
org.gradle.api.Project#files(Object...)
zulässige Argument, einschließlich:java.lang.String
,java.io.File
, oderorg.gradle.api.file.FileCollection
Mehrere Verzeichnisse für eine einzelne Build-Variante durch Bereitstellung einer Liste oder
FileCollection
Instanz
Erzwingen Sie abschließend einen Testabsturz, um die Einrichtung von Crashlytics abzuschließen und erste Daten im Crashlytics-Dashboard der Firebase-Konsole anzuzeigen.
Option : Laden Sie Symbole für Nicht-Gradle-Builds oder unzugängliche, nicht entfernte native Bibliotheken hoch
Diese Option kann in den folgenden Situationen hilfreich sein:
Wenn Sie einen anderen Build-Prozess als Gradle verwenden
Wenn Ihnen Ihre nicht entfernten nativen Bibliotheken auf eine Weise zur Verfügung gestellt werden, auf die Sie während Gradle-Builds nicht zugreifen können
Diese Option erfordert, dass Sie einen Firebase-CLI-Befehl ausführen, wenn Sie einen Release-Build oder einen anderen Build erstellen, für den Sie symbolisierte Stack-Traces in der Firebase-Konsole sehen möchten.
Stellen Sie sicher, dass Sie die folgenden ersten Aufgaben des Hauptworkflows weiter oben auf dieser Seite abgeschlossen haben:
Das Crashlytics SDK für NDK und das Crashlytics Gradle-Plugin wurden hinzugefügt.
Beachten Sie, dass Sie bei dieser Option nicht die
firebaseCrashlytics
Erweiterung hinzufügen oder das automatische Hochladen von Symbolen einrichten müssen, da Sie stattdessen die Firebase-CLI (nächste Schritte unten) verwenden, um Ihre Symboldateien zu generieren und hochzuladen.Richten Sie Ihre Umgebung und Ihr Projekt für das Hochladen von Symbolen ein:
Befolgen Sie die Anweisungen, um die Firebase-CLI zu installieren .
Wenn Sie die CLI bereits installiert haben, stellen Sie sicher, dass Sie auf die neueste Version aktualisieren .
(nur für Apps mit Android-API-Level 30+) Aktualisieren Sie
AndroidManifest.xml
Vorlage Ihrer App, um das Pointer-Tagging zu deaktivieren:Aktivieren Sie das Kontrollkästchen für Android Player-Einstellungen > Veröffentlichungseinstellungen > Erstellen > Benutzerdefiniertes Hauptmanifest .
Öffnen Sie die Manifestvorlage unter
Assets/Plugins/Android/AndroidManifest.xml
.Fügen Sie dem Anwendungs-Tag das folgende Attribut hinzu:
<application android:allowNativeHeapPointerTagging="false" ... />
Erstellen Sie Ihr Projekt.
Laden Sie Ihre Symbolinformationen hoch.
Sobald Ihr Build abgeschlossen ist, generieren Sie eine Crashlytics-kompatible Symboldatei und laden Sie sie auf Firebase-Server hoch, indem Sie den folgenden Firebase-CLI-Befehl ausführen:
firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/SYMBOLS
FIREBASE_APP_ID : Ihre Firebase-Android-App-ID (nicht Ihr Paketname)
Beispiel-ID einer Firebase-Android-App:1:567383003300:android:17104a2ced0c9b9b
Hier sind zwei Möglichkeiten, Ihre Firebase-App-ID zu finden:
In Ihrer Datei
google-services.json
ist Ihre App-ID der Wertmobilesdk_app_id
. oderGehen Sie in der Firebase-Konsole zu Ihren Projekteinstellungen . Scrollen Sie nach unten zur Karte „Ihre Apps“ und klicken Sie dann auf die gewünschte Firebase-App, um deren App-ID zu finden.
PATH/TO/SYMBOLS : Der Pfad zur von der CLI generierten Symboldatei
In ein Android Studio-Projekt exportiert – PATH/TO/SYMBOLS kann ein beliebiges Verzeichnis sein. Die Firebase-CLI durchsucht das angegebene Verzeichnis rekursiv nach nativen Bibliotheken mit der Erweiterung
.so
.Erstellen Sie das APK direkt aus Unity heraus – PATH/TO/SYMBOLS ist der Pfad der komprimierten Symboldatei, die nach Abschluss Ihres Builds im Stammverzeichnis des Projekts generiert wurde (zum Beispiel:
myproject/myapp-1.0-v100.symbols.zip
).
Sehen Sie sich erweiterte Optionen für die Verwendung des Firebase-CLI-Befehls zum Generieren und Hochladen von Symboldateien an
Flagge Beschreibung --generator=csym
Verwendet den alten cSYM-Symboldateigenerator anstelle des Standard-Breakpad-Generators
Nicht zur Verwendung empfohlen. Wir empfehlen die Verwendung des standardmäßigen Breakpad-Symboldateigenerators.
--generator=breakpad
Verwendet den Breakpad-Symboldateigenerator
Beachten Sie, dass die Standardeinstellung für die Symboldateigenerierung Breakpad ist. Verwenden Sie dieses Flag nur, wenn Sie es hinzugefügt haben
symbolGenerator { csym() }
in Ihrer Build-Konfiguration und Sie möchten es überschreiben, um stattdessen Breakpad zu verwenden.--dry-run
Erzeugt die Symboldateien, lädt sie jedoch nicht hoch
Dieses Flag ist nützlich, wenn Sie den Inhalt der gesendeten Dateien überprüfen möchten.
--debug
Bietet zusätzliche Debugging-Informationen Erzwingen Sie abschließend einen Testabsturz, um die Einrichtung von Crashlytics abzuschließen und erste Daten im Crashlytics-Dashboard der Firebase-Konsole anzuzeigen.
Nachdem Sie Ihre App erstellt haben, um einen Absturz zu erzwingen, müssen Sie unbedingt den Firebase-CLI-Befehl
crashlytics:symbols:upload
ausführen, um Ihre Symboldatei hochzuladen.