Firebase Crashlytics-Absturzberichte anpassen


Im Dashboard Crashlytics können Sie auf ein Problem klicken, um einen detaillierten Ereignisbericht aufzurufen. Sie können diese Berichte anpassen, um ein besseres Verständnis was in Ihrer App vor sich geht, und unter welchen Umständen die Ereignisse gemeldet werden, Crashlytics

Nicht erfasste Ausnahmen melden

Sie können automatisch alle schwerwiegenden Fehler, die in der Flutter- durch Überschreiben von FlutterError.onError durch FirebaseCrashlytics.instance.recordFlutterFatalError. Wenn Sie auch „nicht fatale“ Ausnahmen abfangen möchten, ü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 erkannt:

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

Sie können den PlatformDispatcher.instance.onError-Handler verwenden, um solche Fehler zu erfassen:

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

Wenn Sie Fehler außerhalb des Flutter-Kontexts abfangen möchten, installieren Sie einen Fehlerlistener auf der aktuellen Isolate:

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

Erkannte Ausnahmen melden

Mit Crashlytics kannst du nicht nur automatisch App-Abstürze melden, zeichnen Sie nicht schwerwiegende Ausnahmen auf und senden sie an Sie, wenn das nächste Mal ein schwerwiegender gemeldet wird oder wenn die App neu gestartet wird.

Verwenden Sie die Methode recordError, um nicht fatale Ausnahmen in den Catch-Blöcken Ihrer App zu erfassen. 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. Das ist mit der Eigenschaft information möglich:

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 Leistung Ihrer App zu minimieren. Um das Netzwerk Ihrer Nutzer zu verkleinern Zugriffe wird, wird die Anzahl der Berichte, die vom Gerät gesendet werden, in Crashlytics begrenzt. wenn nötig.

Benutzerdefinierte Schlüssel hinzufügen

Mit benutzerdefinierten Schlüsseln können Sie den spezifischen Status Ihrer App abrufen, der zu einem Absturz führte. Sie können Ihren Absturzberichten beliebige Schlüssel/Wert-Paare zuordnen und dann mithilfe der benutzerdefinierten Schlüssel Absturzberichte in der Firebase-Konsole suchen und filtern.

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

  • Wenn Sie ein bestimmtes Problem in der Konsole überprüfen, können Sie die zugehöriger benutzerdefinierter Schlüssel für jedes Ereignis (Unter-Tab Schlüssel) und filtern Sie sogar Ereignisse nach benutzerdefinierten Schlüsseln ändern (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);

Benutzerdefinierte Protokollmeldungen hinzufügen

Wenn Sie mehr Kontext zu den Ereignissen erhalten möchten, 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 dem Tab Crashlytics Protokolle an.

Verwende log, um Probleme zu lokalisieren. Beispiel:

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

Nutzerkennungen festlegen

Um ein Problem zu diagnostizieren, ist es oft hilfreich zu wissen, welche Nutzer eines bestimmten Absturzes. Crashlytics bietet eine Möglichkeit, Nutzer in Ihren Absturzberichten anonym zu identifizieren.

Wenn Sie Ihren Berichten User-IDs hinzufügen möchten, weisen Sie jedem Nutzer eine eindeutige Kennung in Form einer ID-Nummer, eines Tokens oder eines Hashwerts zu:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Wenn Sie eine User-ID nach dem Festlegen löschen müssen, setzen Sie den Wert auf ein leerer String. Durch das Löschen einer Nutzer-ID werden vorhandene Crashlytics-Einträge nicht entfernt. Wenn Sie Einträge löschen möchten, die mit einer Nutzer-ID verknüpft sind, wenden Sie sich an den Firebase-Support.

Navigationspfadlogs abrufen

Navigationspfadlogs geben Aufschluss über die Interaktionen eines Nutzers mit Ihrer App, die zu einem Absturz, einem nicht schwerwiegenden Ereignis oder einem ANR-Ereignis geführt haben. Diese Protokolle können hilfreich sein, wenn Sie versuchen, ein Problem zu reproduzieren und zu beheben.

Breadcrumb-Protokolle werden von Google Analytics unterstützt. Wenn Sie also breadcrumb-Protokolle erhalten möchten, müssen Sie Google Analytics für Ihr Firebase-Projekt aktivieren und Ihrer App das Firebase SDK für Google Analytics hinzufügen. Sobald diese Anforderungen erfüllt sind, werden breadcrumb-Protokolle automatisch in den Daten eines Ereignisses auf dem Tab Protokolle angezeigt, wenn Sie sich die Details eines Problems ansehen.

Das Analytics-SDK protokolliert automatisch das screen_view-Ereignis Dadurch können in den Navigationspfadlogs eine Liste der Bildschirme angezeigt werden, die vor dem Aufruf nicht schwerwiegenden Absturz-, nicht schwerwiegenden oder ANR-Ereignisses. Ein screen_view-Navigationspfad-Log enthält einen firebase_screen_class-Parameter.

In Navigationspfadlogs benutzerdefinierten Ereignissen, die Sie manuell im Sitzung, einschließlich der Ereignisparameterdaten. Anhand dieser Daten kann eine Reihe von Nutzeraktionen, die zu einem Absturz, nicht schwerwiegenden oder ANR-Ereignis geführt haben.

Sie können Erhebung und Verwendung von Google Analytics-Daten kontrollieren, einschließlich der Daten, mit denen Navigationspfadlogs gefüllt werden.

Berichte mit Einwilligung aktivieren

Standardmäßig erfasst Crashlytics automatisch Absturzberichte für alle Nutzer Ihrer App. Um Nutzern mehr Kontrolle über die von ihnen gesendeten Daten zu geben, können Sie die Funktion „Opt-in-Berichte“ aktivieren. Dazu deaktivieren Sie die automatische Berichterstellung und senden Daten nur dann an Crashlytics, wenn Sie dies in Ihrem Code angeben:

  1. Automatische Erhebung nativ deaktivieren:

    Apple-Plattformen

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

    • Schlüssel: FirebaseCrashlyticsCollectionEnabled
    • Wert: false

    Android

    Fügen Sie in der AndroidManifest.xml-Datei im application-Block das Tag meta-data hinzu, um die automatische Erfassung zu deaktivieren:

    <meta-data
        android:name="firebase_crashlytics_collection_enabled"
        android:value="false" />
    
  2. Aktivieren Sie die Erhebung für ausgewählte Nutzer, indem Sie die Crashlytics-Daten aufrufen Sammlungsüberschreibung während der Laufzeit.

    Der Überschreibungswert bleibt bei jedem Start Ihrer App erhalten, damit Crashlytics Berichte automatisch erfassen kann. Wenn Sie die automatische Absturzmeldung deaktivieren möchten, geben Sie false als Überschreibungswert an. Wenn der Wert auf false festgelegt ist, wird der neue Wert erst bei der nächsten Ausführung der App angewendet.

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
    

Crash Insights-Daten verwalten

Mit Crash Insights können Sie Ihren anonymisierten Stack vergleichen und Probleme beheben zu Traces von anderen Firebase-Apps und teilen Ihnen mit, ob das Problem Teil eines größeren Trends sind. Bei vielen Problemen finden Sie in Crash Insights sogar Ressourcen, die Ihnen bei der Fehlerbehebung helfen.

In Crash Insights werden aggregierte Absturzdaten verwendet, um häufige Stabilitätstrends zu identifizieren. Wenn Sie die Daten Ihrer App nicht freigeben möchten, können Sie Crash Insights oben in der Liste der Crashlytics-Probleme in der Firebase-Konsole im Menü Crash Insights deaktivieren.