Passen Sie Ihre Firebase Crashlytics-Absturzberichte an

Im Crashlytics-Dashboard können Sie auf ein Problem klicken und einen detaillierten Ereignisbericht erhalten. Sie können diese Berichte anpassen, um besser zu verstehen, was in Ihrer App passiert und welche Umstände im Zusammenhang mit Ereignissen auftreten, die an Crashlytics gemeldet werden.

Melden Sie nicht erfasste Ausnahmen

Sie können alle „schwerwiegenden“ Fehler, die innerhalb des Flutter-Frameworks ausgelöst werden, automatisch abfangen, indem Sie FlutterError.onError mit FirebaseCrashlytics.instance.recordFlutterFatalError überschreiben. Um alternativ auch „nicht schwerwiegende“ Ausnahmen abzufangen, überschreiben Sie FlutterError.onError mit FirebaseCrashlytics.instance.recordFlutterError :

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

  await Firebase.initializeApp();
  bool weWantFatalErrorRecording = true;
  FlutterError.onError = (errorDetails) {
    if(weWantFatalErrorRecording){
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    } else {
      FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
    }
  };

  runApp(MyApp());
}

Asynchrone Fehler

Asynchrone Fehler werden vom Flutter-Framework nicht abgefangen:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Um solche Fehler abzufangen, können Sie den Handler PlatformDispatcher.instance.onError verwenden:

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());

}

Fehler außerhalb von Flutter

Um Fehler abzufangen, die außerhalb des Flutter-Kontexts auftreten, installieren Sie einen Fehler-Listener auf dem aktuellen Isolate :

Isolate.current.addErrorListener(RawReceivePort((pair) async {
  final List<dynamic> errorAndStacktrace = pair;
  await FirebaseCrashlytics.instance.recordError(
    errorAndStacktrace.first,
    errorAndStacktrace.last,
    fatal: true,
  );
}).sendPort);

Abgefangene Ausnahmen melden

Zusätzlich zur automatischen Meldung der Abstürze Ihrer App können Sie mit Crashlytics nicht schwerwiegende Ausnahmen aufzeichnen und diese an Sie senden, wenn das nächste Mal ein schwerwiegendes Ereignis gemeldet wird oder wenn die App neu gestartet wird.

Verwenden Sie die Methode recordError , um nicht schwerwiegende Ausnahmen in den Catch-Blöcken Ihrer App aufzuzeichnen. Zum Beispiel:

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error'
);

// Or you can use:
await FirebaseCrashlytics.instance.recordFlutterError(errorDetails);

Möglicherweise möchten Sie auch weitere Informationen zum Fehler protokollieren, was mit der information Eigenschaft möglich ist:

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error',
  information: ['further diagnostic information about the error', 'version 2.0'],
);

Diese Ausnahmen werden in der Firebase-Konsole als nicht schwerwiegende Probleme angezeigt. Die Problemübersicht enthält alle Statusinformationen, die Sie normalerweise bei Abstürzen erhalten, sowie Aufschlüsselungen nach Version und Hardwaregerät.

Crashlytics verarbeitet Ausnahmen in einem dedizierten Hintergrundthread, um die Auswirkungen auf die Leistung Ihrer App zu minimieren. Um den Netzwerkverkehr Ihrer Benutzer zu reduzieren, begrenzt Crashlytics bei Bedarf die Anzahl der vom Gerät gesendeten Berichte.

Fügen Sie benutzerdefinierte Schlüssel hinzu

Mit benutzerdefinierten Schlüsseln können Sie den spezifischen Status Ihrer App ermitteln, der zu einem Absturz geführt hat. Sie können Ihren Absturzberichten beliebige Schlüssel/Wert-Paare zuordnen und dann die benutzerdefinierten Schlüssel zum Suchen und Filtern von Absturzberichten in der Firebase-Konsole verwenden.

  • Im Crashlytics-Dashboard können Sie nach Problemen suchen, die einem benutzerdefinierten Schlüssel entsprechen.

  • Wenn Sie ein bestimmtes Problem in der Konsole überprüfen, können Sie die zugehörigen benutzerdefinierten Schlüssel für jedes Ereignis anzeigen (Unterregisterkarte „Schlüssel “) und die Ereignisse sogar nach benutzerdefinierten Schlüsseln filtern (Menü „Filter“ oben auf der Seite).

Verwenden Sie die Instanzmethode setCustomKey , um Schlüssel/Wert-Paare festzulegen. Hier sind einige Beispiele:

// Set a key to a string.
FirebaseCrashlytics.instance.setCustomKey('str_key', 'hello');

// Set a key to a boolean.
FirebaseCrashlytics.instance.setCustomKey("bool_key", true);

// Set a key to an int.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1);

// Set a key to a long.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1L);

// Set a key to a float.
FirebaseCrashlytics.instance.setCustomKey("float_key", 1.0f);

// Set a key to a double.
FirebaseCrashlytics.instance.setCustomKey("double_key", 1.0);

Fügen Sie benutzerdefinierte Protokollnachrichten hinzu

Um mehr Kontext für die Ereignisse zu erhalten, die zu einem Absturz geführt haben, können Sie Ihrer App benutzerdefinierte Crashlytics-Protokolle hinzufügen. Crashlytics verknüpft die Protokolle mit Ihren Absturzdaten und zeigt sie in der Firebase-Konsole auf der Registerkarte „Crashlytics- Protokolle“ an.

Verwenden Sie log , um Probleme zu lokalisieren. Zum Beispiel:

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Legen Sie Benutzerkennungen fest

Um ein Problem zu diagnostizieren, ist es oft hilfreich zu wissen, bei welchem ​​Ihrer Benutzer ein bestimmter Absturz aufgetreten ist. Crashlytics bietet eine Möglichkeit, Benutzer in Ihren Absturzberichten anonym zu identifizieren.

Um Ihren Berichten Benutzer-IDs hinzuzufügen, weisen Sie jedem Benutzer eine eindeutige Kennung in Form einer ID-Nummer, eines Tokens oder eines Hash-Werts zu:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Wenn Sie jemals eine Benutzerkennung löschen müssen, nachdem Sie sie festgelegt haben, setzen Sie den Wert auf eine leere Zeichenfolge zurück. Durch das Löschen einer Benutzerkennung werden vorhandene Crashlytics-Datensätze nicht entfernt. Wenn Sie mit einer Benutzer-ID verknüpfte Datensätze löschen müssen, wenden Sie sich an den Firebase-Support .

Holen Sie sich Breadcrumb-Protokolle

Mithilfe von Breadcrumb-Protokollen erhalten Sie ein besseres Verständnis der Interaktionen, die ein Benutzer mit Ihrer App hatte und die zu einem Absturz, einem nicht schwerwiegenden Ereignis oder einem ANR-Ereignis führten. Diese Protokolle können hilfreich sein, wenn Sie versuchen, ein Problem zu reproduzieren und zu debuggen.

Breadcrumb-Protokolle werden von Google Analytics unterstützt. Um Breadcrumb-Protokolle zu erhalten, müssen Sie Google Analytics für Ihr Firebase-Projekt aktivieren und das Firebase SDK für Google Analytics zu Ihrer App hinzufügen . Sobald diese Anforderungen erfüllt sind, werden Breadcrumb-Protokolle automatisch in die Daten eines Ereignisses auf der Registerkarte „Protokolle“ eingefügt, wenn Sie die Details eines Problems anzeigen.

Das Analytics SDK protokolliert automatisch das Ereignis screen_view , wodurch in den Breadcrumb-Protokollen eine Liste der Bildschirme angezeigt werden kann, die vor dem Absturz, dem nicht schwerwiegenden Ereignis oder dem ANR-Ereignis angezeigt wurden. Ein screen_view Breadcrumb-Protokoll enthält einen firebase_screen_class -Parameter.

Breadcrumb-Protokolle werden auch mit allen benutzerdefinierten Ereignissen gefüllt, die Sie manuell innerhalb der Benutzersitzung protokollieren, einschließlich der Parameterdaten des Ereignisses. Diese Daten können dabei helfen, eine Reihe von Benutzeraktionen aufzuzeigen, die zu einem Absturz, einem nicht schwerwiegenden oder einem ANR-Ereignis führen.

Beachten Sie, dass Sie die Erfassung und Verwendung von Google Analytics-Daten steuern können, einschließlich der Daten, die in Breadcrumb-Protokollen eingetragen werden.

Aktivieren Sie die Opt-in-Berichterstellung

Standardmäßig sammelt Crashlytics automatisch Absturzberichte für alle Benutzer Ihrer App. Um Benutzern mehr Kontrolle über die von ihnen gesendeten Daten zu geben, können Sie die Opt-in-Berichterstellung aktivieren, indem Sie die automatische Berichterstellung deaktivieren und Daten nur dann an Crashlytics senden, wenn Sie dies in Ihrem Code festlegen:

  1. Deaktivieren Sie die automatische Erfassung nativ:

    Apple-Plattformen

    Fügen Sie Ihrer Info.plist Datei einen neuen Schlüssel hinzu:

    • Schlüssel: FirebaseCrashlyticsCollectionEnabled
    • Wert: false

    Android

    Fügen Sie im application Ihrer AndroidManifest.xml Datei ein meta-data Tag hinzu, um die automatische Erfassung zu deaktivieren:

    <meta-data
    android:name="firebase_crashlytics_collection_enabled"
    android:value="false" />

  2. Aktivieren Sie die Erfassung für ausgewählte Benutzer, indem Sie zur Laufzeit die Crashlytics-Datenerfassungsüberschreibung aufrufen.

    Der Überschreibungswert bleibt über alle Starts Ihrer App hinweg bestehen, sodass Crashlytics automatisch Berichte sammeln kann. Um die automatische Absturzberichterstattung zu deaktivieren, übergeben Sie false als Überschreibungswert. Bei Festlegung auf false wird der neue Wert erst bei der nächsten Ausführung der App angewendet.

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);

Verwalten Sie Crash Insights-Daten

Crash Insights hilft Ihnen bei der Lösung von Problemen, indem es Ihre anonymisierten Stack-Traces mit Traces von anderen Firebase-Apps vergleicht und Sie darüber informiert, ob Ihr Problem Teil eines größeren Trends ist. Für viele Probleme stellt Crash Insights sogar Ressourcen zur Verfügung, die Sie beim Debuggen des Absturzes unterstützen.

Crash Insights verwendet aggregierte Absturzdaten, um allgemeine Stabilitätstrends zu identifizieren. Wenn Sie die Daten Ihrer App nicht weitergeben möchten, können Sie Crash Insights über das Crash Insights- Menü oben in Ihrer Crashlytics-Problemliste in der Firebase-Konsole deaktivieren.