Premiers pas avec Performance Monitoring pour les plates-formes Apple

Avant de commencer

Si ce n'est pas encore fait, ajoutez Firebase à votre projet Apple.

Étape 1 : Ajoutez Performance Monitoring à votre application

Une fois le SDK Performance Monitoring ajouté, Firebase commence automatiquement à collecter des données sur le rendu d'écran de votre application, des données liées au cycle de vie de votre application (comme le temps de démarrage de l'application) et des données sur les requêtes réseau HTTP/S.

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 Performance Monitoring.
  4. Ajoutez l'indicateur -ObjC à la section Other Linker Flags (Autres indicateurs Linker) des paramètres de compilation de votre cible.
  5. 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 FirebaseCore dans votre UIApplicationDelegate, ainsi que tous les autres modules Firebase utilisés par le délégué de votre application. Par exemple, pour utiliser Cloud Firestore et Authentication :

    SwiftUI

    import SwiftUI
import FirebaseCore
import FirebaseFirestore
import FirebaseAuth
// ...

    Swift

    import FirebaseCore
import FirebaseFirestore
import FirebaseAuth
// ...

    Objective-C

    @import FirebaseCore;
@import FirebaseFirestore;
@import FirebaseAuth;
// ...
  2. Configurez une instance partagée FirebaseApp dans la méthode application(_:didFinishLaunchingWithOptions:) du délégué de votre application :

    SwiftUI

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

    Swift

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

    Objective-C

    // Use Firebase library to configure APIs
[FIRApp configure];
  3. Si vous utilisez SwiftUI, vous devez créer un délégué d'application et l'associer à votre structure App via UIApplicationDelegateAdaptor ou NSApplicationDelegateAdaptor. Vous devez également désactiver le swizzling du délégué d'application. Pour en savoir plus, consultez les instructions SwiftUI.

    SwiftUI

    @main
struct YourApp: App {
  // register app delegate for Firebase setup
  @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate

  var body: some Scene {
    WindowGroup {
      NavigationView {
        ContentView()
      }
    }
  }
}

  4. Recompilez votre application.

Étape 2 : Générez des événements de performances pour l'affichage initial des données

Firebase commence à traiter les événements lorsque vous ajoutez le SDK à votre application. Si vous êtes encore en phase de développement local, interagissez avec votre application pour générer des événements pour la collecte et le traitement des données initiales.

  1. Continuez à développer votre application à l'aide d'un simulateur ou d'un appareil de test.

  2. Générez des événements en basculant votre application entre l'arrière-plan et le premier plan plusieurs fois, en interagissant avec votre application en naviguant entre les écrans et/ou en déclenchant des requêtes réseau.

  3. Accédez au tableau de bord Performances de la console Firebase. Vos premières données devraient s'afficher au bout de quelques minutes.

    Si vos données initiales ne s'affichent pas, consultez les conseils de dépannage.

Étape 3 : (Facultatif) Affichez les messages du journal pour les événements de performances.

  1. Activez la journalisation du débogage comme suit :

    1. Dans Xcode (version 16.2 ou ultérieure), sélectionnez Product (Produit) > Scheme (Schéma) > Edit scheme (Modifier le schéma).
    2. Sélectionnez Run (Exécuter) dans le menu de gauche, puis sélectionnez l'onglet Arguments.
    3. Dans la section Arguments Passed on Launch (Arguments transmis au lancement), ajoutez -FIRDebugEnabled.

  2. Recherchez d'éventuels messages d'erreur dans vos messages de journaux.

  3. Performance Monitoring ajoute le tag Firebase/Performance à ses messages de journal pour que vous puissiez les filtrer.

  4. Recherchez les types de journaux suivants, qui indiquent que Performance Monitoring enregistre les événements de performances :

    • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL

  5. Cliquez sur l'URL pour afficher vos données dans la console Firebase. La mise à jour des données dans le tableau de bord peut prendre quelques instants.

Si votre application n'enregistre pas les événements de performances, consultez les conseils de dépannage.

Étape 4 : (Facultatif) Ajoutez une surveillance personnalisée pour un code spécifique

Pour surveiller les données de performances associées à un code spécifique dans votre application, vous pouvez instrumenter des traces de code personnalisées.

Avec une trace de code personnalisée, vous pouvez mesurer le temps nécessaire à votre application pour effectuer une tâche ou un ensemble de tâches spécifiques, comme charger un ensemble d'images ou interroger votre base de données. La métrique par défaut pour une trace de code personnalisé est sa durée, mais vous pouvez également ajouter des métriques personnalisées, telles que les accès au cache et les avertissements de mémoire.

Dans votre code, vous définissez le début et la fin d'une trace de code personnalisée (et ajoutez les métriques personnalisées souhaitées) à l'aide de l'API fournie par le SDK Performance Monitoring.

Consultez Ajouter une surveillance pour un code spécifique pour en savoir plus sur ces fonctionnalités et sur la façon de les ajouter à votre application.

Étape 5 : Déployez votre application, puis examinez les résultats

Une fois que vous avez validé Performance Monitoring à l'aide du simulateur Xcode et d'un ou plusieurs appareils de test, vous pouvez déployer la version mise à jour de votre application auprès de vos utilisateurs.

Vous pouvez surveiller les données sur les performances dans le tableau de bord Performances de la console Firebase.

Problèmes connus

  • Performance Monitoring présente des problèmes de compatibilité connus avec GTMSQLite. Nous vous recommandons de ne pas utiliser Performance Monitoring avec les applications qui utilisent GTMSQLite.
  • Le swizzling de méthode après l'appel de FirebaseApp.configure() peut interférer avec le SDK Performance Monitoring.
  • En raison de problèmes connus avec le simulateur iOS 8.0-8.2, Performance Monitoring ne peut pas capturer les événements de performances. Ces problèmes sont résolus dans le simulateur iOS 8.3 et les versions ultérieures.
  • Les connexions établies à l'aide de backgroundSessionConfiguration d'NSURLSession afficheront des temps de connexion plus longs que prévu. Ces connexions sont exécutées hors processus et les timings reflètent les événements de rappel dans le processus.

Étapes suivantes