Firebase Crashlytics-Absturzberichte anpassen

iOS+ Android Flutter Unity

Im Dashboard Crashlytics können Sie auf ein Problem klicken, um einen detaillierten Ereignisbericht aufzurufen. Sie können diese Berichte anpassen, um besser nachvollziehen zu können, was in Ihrer App passiert und welche Umstände zu den bei Crashlytics gemeldeten Ereignissen geführt haben.

• Melden Sie nicht erfasste Ausnahmen und erfasste Ausnahmen an Crashlytics.

• Instrumentieren Sie Ihre App, um benutzerdefinierte Schlüssel, benutzerdefinierte Lognachrichten und Nutzer-IDs zu erfassen.

• Sie erhalten automatisch Brotkrummenprotokolle, wenn in Ihrer App das Firebase SDK für Google Analytics verwendet wird. Diese Logs geben Aufschluss über Nutzeraktionen, die zu einem von Crashlytics erfassten Ereignis in Ihrer App geführt haben.

• Deaktivieren Sie die automatische Absturzberichterstattung und aktivieren Sie die Meldefunktion für Ihre Nutzer. Standardmäßig erhebt Crashlytics automatisch platformspezifische Absturzberichte für alle Nutzer Ihrer App.

Hinweis :Bei Flutter-Apps werden fatale Fehlerberichte in Echtzeit an Crashlytics gesendet, ohne dass der Nutzer die Anwendung neu starten muss. Nicht kritische Berichte werden auf die Festplatte geschrieben, um sie zusammen mit dem nächsten kritischen Bericht oder beim Neustart der App zu senden.

Nicht erfasste Ausnahmen melden

Sie können alle „fatalen“ Fehler, die im Flutter-Framework auftreten, automatisch abfangen, indem Sie FlutterError.onError durch FirebaseCrashlytics.instance.recordFlutterFatalError überschreiben. Wenn Sie auch „nicht schwerwiegende“ 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();
  }
  ...
)

Um solche Fehler zu erkennen, können Sie den PlatformDispatcher.instance.onError-Handler 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

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 können Sie nicht schwerwiegende Ausnahmen nicht nur automatisch melden, sondern auch aufzeichnen und sich senden lassen, wenn das nächste Mal ein schwerwiegendes Ereignis gemeldet wird oder die App neu gestartet wird.

Hinweis: In Crashlytics werden nur die letzten acht aufgezeichneten nicht kritischen Ausnahmen gespeichert. Wenn Ihre App mehr als acht Ausnahmen wirft, gehen ältere Ausnahmen verloren. Dieser Zähler wird jedes Mal zurückgesetzt, wenn eine fatale Ausnahme ausgelöst wird, da dadurch ein Bericht an Crashlytics gesendet 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'],
);

Warnung :Wenn Sie einen eindeutigen Wert (z. B. eine Nutzer-ID oder einen Zeitstempel) in die Ausnahmenachricht aufnehmen möchten, verwenden Sie einen benutzerdefinierten Schlüssel, anstatt den Wert direkt in die Ausnahmenachricht einzufügen. Wenn Sie Werte direkt hinzufügen, kann das zu verschiedenen Problemen führen und dazu, dass Crashlytics Fehler bei der Berichterstellung in Ihrer App einschränkt.

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 speziellen Hintergrund-Thread, um die Leistungsauswirkungen auf Ihre App zu minimieren. Um den Netzwerkverkehr Ihrer Nutzer zu reduzieren, begrenzt Crashlytics bei Bedarf die Anzahl der vom Gerät gesendeten Berichte.

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 sich ein bestimmtes Problem in der Console ansehen, können Sie sich die zugehörigen benutzerdefinierten Schlüssel für jedes Ereignis ansehen (Untertab Schlüssel) und die Ereignisse sogar nach benutzerdefinierten Schlüsseln filtern (Menü Filter oben auf der Seite).

Hinweis: Crashlytics unterstützt maximal 64 Schlüssel/Wert-Paare. Danach werden keine weiteren Werte gespeichert. Jedes Schlüssel/Wert-Paar kann bis zu 1 KB groß sein.

Verwenden Sie die Instanzmethode setCustomKey, um Schlüssel/Wert-Paare festzulegen. Hier 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.

Hinweis: Um eine Verlangsamung Ihrer App zu vermeiden, begrenzt Crashlytics Logs auf 64 KB und löscht ältere Logeinträge, wenn die Logs einer Sitzung dieses Limit überschreiten.

Verwenden Sie log, um Probleme zu ermitteln. Beispiel:

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

Nutzerkennungen festlegen

Um ein Problem zu diagnostizieren, ist es oft hilfreich zu wissen, bei welchem Nutzer ein bestimmter Absturz aufgetreten ist. 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 Nutzer-ID nach dem Festlegen löschen möchten, setzen Sie den Wert auf einen leeren String zurück. 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.

Navigationspfad-Logs 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 zusammen mit den Daten eines Ereignisses auf dem Tab Protokolle angezeigt, wenn Sie sich die Details eines Problems ansehen.

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

In Breadcrumb-Protokollen werden auch alle benutzerdefinierten Ereignisse erfasst, die Sie während der Sitzung des Nutzers manuell erfassen, einschließlich der Parameterdaten des Ereignisses. Anhand dieser Daten können Sie eine Reihe von Nutzeraktionen nachvollziehen, die zu einem Absturz, einem nicht schwerwiegenden Fehler oder einem ANR-Ereignis geführt haben.

Sie können die Erhebung und Verwendung von Google Analytics-Daten steuern. Dazu gehören auch die Daten, die in Breadcrumb-Logs eingefügt 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 Datenerhebungsüberschreibung Crashlytics zur Laufzeit aufrufen.

   Der Überschreibungswert bleibt bei jedem Start Ihrer App erhalten, damit Crashlytics Berichte automatisch erfassen kann. Wenn Sie die automatische Absturzmeldung deaktivieren möchten, legen Sie false als Überschreibungswert fest. 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);
   

Hinweis: Wenn Sie die automatische Berichterstellung deaktivieren, beachten Sie Folgendes:

• Wenn die Datenerhebung für einen Nutzer deaktiviert ist, speichert Crashlytics Absturzinformationen lokal auf dem Gerät. Wenn die Datenerhebung später aktiviert wird, werden alle auf dem Gerät gespeicherten Absturzinformationen zur Verarbeitung an Crashlytics gesendet.
• Wenn Sie die Meldefunktion aktivieren, können Absturzinformationen nur von Nutzern erhoben werden, die die Datenerhebung ausdrücklich aktiviert haben. Die Genauigkeit der Messwerte zu Nutzern ohne Abstürze und Sitzungen ohne Abstürze wird dadurch beeinträchtigt, da Crashlytics nur Informationen zu Abstürzen von diesen Nutzern hat, die die Funktion aktiviert haben, und nicht von allen Ihren Nutzern. Das bedeutet, dass Ihre Messwerte für die Anzahl der Abstürze möglicherweise weniger zuverlässig sind und die Gesamtstabilität Ihrer App weniger widerspiegeln.

Daten zu Absturzinformationen verwalten

Mit Absturzinformationen können Sie Probleme beheben, indem Sie Ihre anonymisierten Stacktraces mit Traces aus anderen Firebase-Apps vergleichen. Außerdem erfahren Sie, ob Ihr Problem Teil eines größeren Trends ist. 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 über das Menü Crash Insights deaktivieren.

Hinweis :Wenn Sie die Datenfreigabe deaktivieren, erhalten Sie auch keine Informationen zu den aufgetretenen Problemen mehr. Es kann bis zu 24 Stunden dauern, bis die Änderungen wirksam werden.