Erste Schritte mit Firebase Crashlytics


In dieser Kurzanleitung wird beschrieben, wie Sie Firebase Crashlytics in Ihrer App mit dem Crashlytics-Flutter-Plug-in einrichten, damit Sie umfassende Absturzberichte in der Firebase-Konsole erhalten.

Für die Einrichtung von Crashlytics benötigen Sie sowohl ein Befehlszeilentool als auch Ihre IDE. Um die Einrichtung abzuschließen, müssen Sie eine Testausnahme erzwingen, damit der erste Absturzbericht an Firebase gesendet wird.

Hinweis

  1. Falls noch nicht geschehen, konfigurieren und initialisieren Sie Firebase in Ihrem Flutter-Projekt.

  2. Empfohlen: Wenn Sie automatisch Navigationspfadlogs erhalten möchten, um Nutzeraktionen zu verstehen, die zu einem Absturz, einem nicht schwerwiegenden Ereignis oder einem ANR-Ereignis geführt haben, müssen Sie Google Analytics in Ihrem Firebase-Projekt aktivieren.

    • Wenn Google Analytics in Ihrem vorhandenen Firebase-Projekt nicht aktiviert ist, können Sie Google Analytics auf dem Tab Integrationen unter  > Projekteinstellungen in der Firebase Console aktivieren.

    • Wenn Sie ein neues Firebase-Projekt erstellen, aktivieren Sie Google Analytics während des Projekterstellungsworkflows.

    Breadcrumb-Logs sind für alle von Crashlytics unterstützten Android- und Apple-Plattformen verfügbar (außer watchOS).

Schritt 1: Crashlytics zu Ihrem Flutter-Projekt hinzufügen

  1. Führen Sie im Stammverzeichnis Ihres Flutter-Projekts den folgenden Befehl aus, um das Flutter-Plug-in für Crashlytics zu installieren.

    Wenn Sie Brotkrummenprotokolle verwenden möchten, fügen Sie Ihrer App auch das Flutter-Plug-in für Google Analytics hinzu. Google Analytics muss in Ihrem Firebase-Projekt aktiviert sein.

    flutter pub add firebase_crashlytics && flutter pub add firebase_analytics

  2. Führen Sie im Stammverzeichnis Ihres Flutter-Projekts den folgenden Befehl aus:

    flutterfire configure

    Wenn Sie diesen Befehl ausführen, wird die Firebase-Konfiguration Ihrer Flutter-App auf den neuesten Stand gebracht und Ihrer Android-App wird das erforderliche Crashlytics-Gradle-Plug-in hinzugefügt.

  3. Erstellen Sie anschließend Ihr Flutter-Projekt neu:

    flutter run

  4. Optional: Wenn in Ihrem Flutter-Projekt das Flag --split-debug-info (und optional auch das Flag --obfuscate) verwendet wird, sind zusätzliche Schritte erforderlich, um lesbare Stack-Traces für Ihre Apps anzuzeigen.

    • Apple-Plattformen: Achten Sie darauf, dass in Ihrem Projekt die empfohlene Versionskonfiguration verwendet wird (Flutter 3.12.0 oder höher und Crashlytics Flutter-Plug-in 3.3.4 oder höher), damit Flutter-Symbole (dSYM-Dateien) automatisch generiert und in Crashlytics hochgeladen werden können.

    • Android: Verwenden Sie die Firebase CLI (Version 11.9.0 oder höher), um Flutter-Debugsymbole hochzuladen. Sie müssen die Debugsymbole vor dem Melden eines Absturzes aus einem Build mit verschleiertem Code hochladen.

      Führen Sie im Stammverzeichnis Ihres Flutter-Projekts den folgenden Befehl aus:

      firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols

      • FIREBASE_APP_ID: Ihre Firebase-Android-App-ID (nicht Ihr Paketname)
        Beispiel für eine Firebase-Android-App-ID: 1:567383003300:android:17104a2ced0c9b9b

      • PATH/TO/symbols: Das Verzeichnis, das Sie beim Erstellen der Anwendung an das --split-debug-info-Flag übergeben

Schritt 2: Absturz-Handler konfigurieren

Sie können automatisch alle Fehler abfangen, die im Flutter-Framework ausgegeben werden, indem Sie FlutterError.onError mit FirebaseCrashlytics.instance.recordFlutterFatalError überschreiben:

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();

  // Pass all uncaught "fatal" errors from the framework to Crashlytics
  FlutterError.onError = FirebaseCrashlytics.instance.recordFlutterFatalError;

  runApp(MyApp());
}

Verwenden Sie PlatformDispatcher.instance.onError, um asynchrone Fehler zu erfassen, die nicht vom Flutter-Framework verarbeitet werden:

Future<void> main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await Firebase.initializeApp();
    FlutterError.onError = (errorDetails) {
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    };
    // Pass all uncaught asynchronous errors that aren't handled by the Flutter framework to Crashlytics
    PlatformDispatcher.instance.onError = (error, stack) {
      FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
      return true;
    };
    runApp(MyApp());

}

Beispiele für die Behandlung anderer Fehlertypen finden Sie unter Absturzberichte anpassen.

Schritt 3: Testabsturz erzwingen, um die Einrichtung abzuschließen

Wenn Sie die Einrichtung von Crashlytics abschließen und erste Daten im Crashlytics-Dashboard der Firebase-Konsole sehen möchten, müssen Sie eine Testausnahme erzwingen.

  1. Fügen Sie Ihrer App Code hinzu, mit dem Sie eine Testausnahme erzwingen können.

    Wenn du einen Fehler-Handler hinzugefügt hast, der FirebaseCrashlytics.instance.recordError(error, stack, fatal: true) für das übergeordnete Zone-Objekt aufruft, kannst du mit dem folgenden Code deiner App eine Schaltfläche hinzufügen, die beim Drücken eine Testausnahme auslöst:

    TextButton(
    onPressed: () => throw Exception(),
    child: const Text("Throw Test Exception"),
),

  2. Erstellen Sie Ihre App und führen Sie sie aus.

  3. Erzwingen Sie das Auftreten der Testausnahme, um den ersten Bericht Ihrer App zu senden:

    1. Öffnen Sie Ihre App auf Ihrem Testgerät oder Emulator.

    2. Klicken Sie in Ihrer App auf die Schaltfläche zum Testen der Ausnahme, die Sie mit dem obigen Code hinzugefügt haben.

  4. Rufen Sie das Crashlytics-Dashboard der Firebase-Konsole auf, um den Testabsturz zu sehen.

    Wenn Sie die Konsole aktualisiert haben und der Test nach fünf Minuten immer noch nicht abgestürzt ist, aktivieren Sie die Debug-Protokollierung, um zu sehen, ob Ihre App Absturzberichte sendet.


Das war's auch schon. Crashlytics überwacht deine App jetzt auf Abstürze und unter Android nicht schwerwiegende Fehler und ANRs. Im Crashlytics-Dashboard können Sie alle Ihre Berichte und Statistiken ansehen und untersuchen.

Nächste Schritte