Erste Schritte mit Firebase Crashlytics


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

Für die Einrichtung von Crashlytics sind Aufgaben sowohl in der Firebase-Konsole als auch in Ihrer IDE erforderlich, z. B. das Hinzufügen einer Firebase-Konfigurationsdatei und des Crashlytics SDK. Um die Einrichtung abzuschließen, müssen Sie einen Testabsturz erzwingen, damit Ihr erster Absturzbericht an Firebase gesendet wird.

Hinweis

  1. Fügen Sie Ihrem Apple-Projekt Firebase hinzu, falls noch nicht geschehen. Wenn Sie keine Apple-App haben, können Sie eine Beispiel-App herunterladen.

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

    • Wenn Google Analytics für Ihr vorhandenes 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 der Projekterstellung.

    Hinweis: Breadcrumb-Logs sind für alle von Crashlytics unterstützten Apple-Plattformen verfügbar, mit Ausnahme von watchOS.

Schritt 1: Crashlytics SDK in Ihre App einfügen

Verwenden Sie Swift Package Manager, um Firebase-Abhängigkeiten zu installieren und zu verwalten.

  1. Öffnen Sie Ihr App-Projekt und gehen Sie in Xcode zu File > Add Packages (Datei > Pakete hinzufügen).
  2. Fügen Sie bei entsprechender Aufforderung das Firebase Apple Platforms SDK-Repository hinzu:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Wählen Sie die Crashlytics-Bibliothek aus.
  5. Wenn Sie Breadcrumb-Logs nutzen möchten, fügen Sie Ihrer App auch das Firebase SDK für Google Analytics hinzu. Achten Sie darauf, dass Google Analytics in Ihrem Firebase-Projekt aktiviert ist.
  6. Fügen Sie das Flag -ObjC dem Abschnitt Other Linker Flags (Weitere Linker-Flags) der Build-Einstellungen Ihres Ziels hinzu.
  7. (Nur macOS) Fügen Sie in Ihrer Info.plist den Schlüssel NSApplicationCrashOnExceptions hinzu und legen Sie ihn auf YES fest.
  8. Wenn Sie fertig, beginnt Xcode automatisch, Ihre Abhängigkeiten im Hintergrund aufzulösen und herunterzuladen.

Konfigurieren Sie als Nächstes das Firebase-Modul:

  1. Importieren Sie das Firebase-Modul in Ihre App-Struktur oder UIApplicationDelegate:

    Swift

    import Firebase

    Objective-C

    @import Firebase;
  2. Konfigurieren Sie eine freigegebene FirebaseApp-Instanz, in der Regel in der Methode application(_:didFinishLaunchingWithOptions:) des App-Delegaten:

    Swift

    // Use the Firebase library to configure APIs.
    FirebaseApp.configure()

    Objective-C

    // Use the Firebase library to configure APIs.
    [FIRApp configure];

Schritt 2: Automatisches Hochladen von dSYM-Dateien in Xcode einrichten

Damit Crashlytics für Menschen lesbare Absturzberichte generieren kann, sind die dSYM-Dateien Ihres Projekts erforderlich. In den folgenden Schritten wird beschrieben, wie Sie Xcode so konfigurieren, dass Ihre dSYMs automatisch erstellt, verarbeitet und hochgeladen werden, wenn Sie Ihre App erstellen.

  1. Öffnen Sie den Xcode-Arbeitsbereich Ihres Projekts und wählen Sie dann die Projektdatei im Navigator auf der linken Seite aus.

  2. Wählen Sie in der Liste ZIELE Ihr primäres Build-Ziel aus.

  3. Klicken Sie auf den Tab Build Settings (Build-Einstellungen) und führen Sie die folgenden Schritte aus, damit Xcode dSYMs für Ihre Builds erstellt.

    1. Klicken Sie auf Alle und suchen Sie dann nach debug information format.

    2. Legen Sie Debug Information Format für alle Build-Typen auf DWARF with dSYM File fest.

  4. Klicken Sie auf den Tab Build Phases und führen Sie dann die folgenden Schritte aus, damit Xcode Ihre dSYMs verarbeiten und die Dateien hochladen kann.

    1. Klicken Sie auf  > New Run Script Phase (Neue Phase für das Ausführen von Skripts).

      Achten Sie darauf, dass die neue Phase Run Script die letzte Build-Phase Ihres Projekts ist. Andernfalls kann Crashlytics dSYMs nicht richtig verarbeiten.

    2. Maximieren Sie den neuen Bereich Skript ausführen.

    3. Fügen Sie im Skriptfeld (unter dem Label Shell) das folgende Ausführungsskript hinzu.

      Dieses Skript verarbeitet die dSYM-Dateien Ihres Projekts und lädt die Dateien in Crashlytics hoch.

      "${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"
    4. Fügen Sie im Bereich Input Files (Eingabedateien) die Pfade zu den Speicherorten der folgenden Dateien hinzu:

      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}
      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}
      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist
      $(TARGET_BUILD_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist
      $(TARGET_BUILD_DIR)/$(EXECUTABLE_PATH)
      Wenn Sie ENABLE_USER_SCRIPT_SANDBOXING=YES und ENABLE_DEBUG_DYLIB=YES in den Build-Einstellungen Ihres Projekts haben, fügen Sie Folgendes hinzu:
      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}.debug.dylib

Weitere Informationen zu dSYM-Dateien und Crashlytics (einschließlich des manuellen Hochladens von dSYM-Dateien) finden Sie unter Deobfuscated crash reports.

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

Damit Sie die Einrichtung von Crashlytics abschließen und erste Daten im Crashlytics-Dashboard der Firebase Console sehen können, müssen Sie einen Testabsturz erzwingen.

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

    Mit dem folgenden Code können Sie Ihrer App eine Schaltfläche hinzufügen, die beim Drücken einen Absturz verursacht. Die Schaltfläche ist mit „Testabsturz“ beschriftet.

    SwiftUI

    Button("Crash") {
      fatalError("Crash was triggered")
    }

    UIKit

    Swift

    import UIKit
    
    class ViewController: UIViewController {
      override func viewDidLoad() {
          super.viewDidLoad()
    
          // Do any additional setup after loading the view, typically from a nib.
    
          let button = UIButton(type: .roundedRect)
          button.frame = CGRect(x: 20, y: 50, width: 100, height: 30)
          button.setTitle("Test Crash", for: [])
          button.addTarget(self, action: #selector(self.crashButtonTapped(_:)), for: .touchUpInside)
          view.addSubview(button)
      }
    
      @IBAction func crashButtonTapped(_ sender: AnyObject) {
          let numbers = [0]
          let _ = numbers[1]
      }
    }

    Objective-C

    #import "ViewController.h"
    
    @implementation ViewController(void)viewDidLoad {
        [super viewDidLoad];
    
        // Do any additional setup after loading the view, typically from a nib.
    
        UIButton* button = [UIButton buttonWithType:UIButtonTypeRoundedRect];
        button.frame = CGRectMake(20, 50, 100, 30);
        [button setTitle:@"Test Crash" forState:UIControlStateNormal];
        [button addTarget:self action:@selector(crashButtonTapped:)
            forControlEvents:UIControlEventTouchUpInside];
        [self.view addSubview:button];
    }
    
     (IBAction)crashButtonTapped:(id)sender {
        @[][1];
    }
    
    @end
  2. Erstellen Sie Ihre App in Xcode und führen Sie sie aus, während der Xcode-Debugger getrennt ist.

    1. Klicken Sie auf Build and then run the current scheme (Aktuelles Schema erstellen und dann ausführen), um Ihre App auf einem Testgerät oder Simulator zu erstellen.

    2. Warten Sie, bis Ihre App ausgeführt wird, und klicken Sie dann auf Schema oder Aktion beenden, um die ursprüngliche Instanz Ihrer App zu schließen. Diese ursprüngliche Instanz enthielt den Debugger, der die Crashlytics-Funktion beeinträchtigt.

  3. Erzwingen Sie den Testabsturz, um den ersten Absturzbericht Ihrer App zu senden:

    1. Öffnen Sie Ihre App auf dem Startbildschirm Ihres Testgeräts oder Simulators.

    2. Klicken Sie in Ihrer App auf die Schaltfläche „Testabsturz“, die Sie mit dem oben stehenden Code hinzugefügt haben.

    3. Nachdem Ihre App abgestürzt ist, führen Sie sie noch einmal in Xcode aus, damit der Absturzbericht an Firebase gesendet werden kann.

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

    Wenn Sie die Konsole aktualisiert haben und der Testabsturz nach fünf Minuten immer noch nicht angezeigt wird, aktivieren Sie das Debug-Logging, um zu sehen, ob Ihre App Absturzberichte sendet.


Geschafft! Crashlytics überwacht jetzt Ihre App auf Abstürze. Im Crashlytics-Dashboard können Sie alle Ihre Berichte und Statistiken ansehen und analysieren.

Nächste Schritte