Premiers pas avec Firebase Crashlytics


Ce guide de démarrage rapide explique comment configurer Firebase Crashlytics dans votre application avec le SDK Firebase Crashlytics afin de pouvoir obtenir des rapports d'erreur complets dans la console Firebase.

La configuration de Crashlytics nécessite des tâches à la fois dans la console Firebase et dans votre IDE (comme ajouter un fichier de configuration Firebase et le SDK Crashlytics). Pour terminer la configuration, vous devez forcer un plantage de test afin d'envoyer votre premier rapport de plantage à Firebase.

Avant de commencer

  1. Si ce n'est pas encore fait, ajoutez Firebase à votre projet Apple. Si vous ne disposez d'aucune application Apple, vous pouvez télécharger une application exemple.

  2. Recommandé : Pour obtenir automatiquement des journaux de repères afin de comprendre les actions des utilisateurs ayant conduit à un plantage, un problème non fatal ou un événement ANR, vous devez activer Google Analytics dans votre projet Firebase.

    • Si Google Analytics n'est pas activé dans votre projet Firebase existant, vous pouvez l'activer dans l'onglet Integrations (Intégrations) de  > Project settings (Paramètres du projet) dans la console Firebase.

    • Si vous créez un projet Firebase, activez Google Analytics pendant le workflow de création de projet.

    Notez que les journaux de fil d'Ariane sont disponibles pour toutes les plates-formes Apple compatibles avec Crashlytics, à l'exception de watchOS.

Étape 1 : Ajouter le SDK Crashlytics à votre application

Utilisez Swift Package Manager pour installer et gérer les dépendances Firebase.

  1. Dans Xcode, à partir de votre projet d'application ouvert, accédez à File > Add Packages (Fichier > Ajouter des packages).
  2. Lorsque vous y êtes invité, ajoutez le dépôt du SDK des plates-formes Firebase pour Apple :
    3.   https://github.com/firebase/firebase-ios-sdk.git
  3. Choisissez la bibliothèque Crashlytics.
  4. Pour profiter des journaux de fil d'Ariane, ajoutez également le SDK Firebase pour Google Analytics à votre application. Assurez-vous que Google Analytics est activé dans votre projet Firebase.
  5. Ajoutez l'indicateur -ObjC à la section Other Linker Flags (Autres indicateurs Linker) des paramètres de compilation de votre cible.
  6. (macOS uniquement) Dans votre Info.plist, ajoutez la clé NSApplicationCrashOnExceptions et définissez-la sur YES.
  7. Lorsque vous avez terminé, Xcode commence à résoudre et à télécharger automatiquement vos dépendances en arrière-plan.

Configurez ensuite le module Firebase:

  1. Importez le module Firebase dans votre struct App ou UIApplicationDelegate :

    Swift 

    import Firebase

    Objective-C 

    @import Firebase;

  2. Configurez une instance partagée FirebaseApp, généralement dans la méthode application(_:didFinishLaunchingWithOptions:) de votre délégué d'application:

    Swift 

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

    Objective-C 

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

Étape 2 : Configurez Xcode pour importer automatiquement les fichiers dSYM

Pour générer des rapports d'erreur lisibles par l'humain, Crashlytics a besoin des fichiers de décodage (dSYM) de votre projet. Les étapes suivantes décrivent comment configurer Xcode pour générer automatiquement vos dSYM, les traiter et les importer chaque fois que vous compilez votre application.

  1. Ouvrez l'espace de travail Xcode de votre projet, puis sélectionnez son fichier de projet dans le navigateur de gauche.

  2. Dans la liste CIBLES, sélectionnez votre cible de compilation principale.

  3. Cliquez sur l'onglet Build Settings (Paramètres de compilation), puis suivez les étapes ci-dessous pour que Xcode génère des dSYM pour vos builds.

    1. Cliquez sur Tous, puis recherchez debug information format.

    2. Définissez Debug Information Format sur DWARF with dSYM File pour tous vos types de compilation.

  4. Cliquez sur l'onglet Build Phases (Phases de compilation), puis suivez les étapes ci-dessous pour que Xcode puisse traiter vos fichiers dSYM et les importer.

    1. Cliquez sur  > Nouvelle phase d'exécution du script.

      Assurez-vous que cette nouvelle phase Run Script (Exécuter le script) est la dernière phase de compilation de votre projet. Sinon, Crashlytics ne pourra pas traiter correctement les dSYM.

    2. Développez la nouvelle section Exécuter le script.

    3. Dans le champ de script (situé sous le libellé Shell), ajoutez le script d'exécution suivant.

      Ce script traite les fichiers dSYM de votre projet et les importe dans Crashlytics.

      "${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"

    4. Dans la section Fichiers d'entrée, ajoutez les chemins d'accès aux emplacements des fichiers suivants :

      ${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)

Pour en savoir plus sur les fichiers dSYM et Crashlytics (y compris comment importer manuellement des fichiers dSYM), consultez Obtenir des rapports d'erreur démasqués.

Étape 3 : Forcez un plantage de test pour terminer la configuration

Pour terminer la configuration de Crashlytics et afficher les données initiales dans le tableau de bord Crashlytics de la console Firebase, vous devez forcer un plantage de test.

  1. Ajoutez du code à votre application que vous pouvez utiliser pour forcer un plantage de test.

    Vous pouvez utiliser le code suivant pour ajouter un bouton à votre application qui, lorsqu'il est enfoncé, provoque un plantage. Le bouton porte le libellé "Tester un plantage".

    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. Créez et exécutez votre application dans Xcode avec le débogueur Xcode déconnecté.

    1. Cliquez sur Build and then run the current scheme (Créer, puis exécuter le schéma actuel) pour créer votre application sur un appareil de test ou un simulateur.

    2. Attendez que votre application s'exécute, puis cliquez sur Arrêter d'exécuter le schéma ou l'action pour fermer l'instance initiale de votre application. Cette instance initiale inclut le débogueur qui interfère avec Crashlytics.

  3. Forcez le plantage de test afin d'envoyer le premier rapport de plantage de votre application :

    1. Ouvrez votre application depuis l'écran d'accueil de votre appareil de test ou de votre simulateur.

    2. Dans votre application, appuyez sur le bouton "Tester le plantage" que vous avez ajouté à l'aide du code ci-dessus.

    3. Une fois que votre application plante, exécutez-la à nouveau depuis Xcode afin qu'elle puisse envoyer le rapport d'erreur à Firebase.

  4. Accédez au tableau de bord Crashlytics de la console Firebase pour voir le plantage du test.

    Si vous avez actualisé la console et que vous ne voyez toujours pas le plantage du test au bout de cinq minutes, activez la journalisation de débogage pour voir si votre application envoie des rapports d'erreur.


C'est tout ! Crashlytics surveille désormais les plantages de votre application. Accédez au tableau de bord Crashlytics pour afficher et examiner tous vos rapports et statistiques.

Étapes suivantes