Catch up on highlights from Firebase at Google I/O 2023. Learn more

Premiers pas avec la surveillance des performances pour les plates-formes Apple

Avant que tu commences

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Apple .

Étape 1 : Ajoutez la surveillance des performances à votre application

Une fois que vous avez ajouté le SDK de surveillance des performances, Firebase commence automatiquement à collecter des données pour le rendu d'écran de votre application , des données relatives au cycle de vie de votre application (comme l'heure de démarrage de l'application ) et des données pour les requêtes réseau HTTP/S .

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

  1. Dans Xcode, avec votre projet d'application ouvert, accédez à File > Add Packages .
  2. Lorsque vous y êtes invité, ajoutez le dépôt du SDK des plates-formes Apple Firebase :
    3.   https://github.com/firebase/firebase-ios-sdk
  3. Choisissez la bibliothèque de surveillance des performances.
  4. Une fois terminé, Xcode commencera automatiquement à résoudre et à télécharger vos dépendances en arrière-plan.

Ensuite, configurez le module Firebase :

  1. Importez le module FirebaseCore dans votre UIApplicationDelegate , ainsi que tout autre module Firebase utilisé par votre délégué d'application. Par exemple, pour utiliser Cloud Firestore et Authentification :

    SwiftUI

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

    Rapide

    import FirebaseCore
import FirebaseFirestore
import FirebaseAuth
// ...

    Objectif c

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

    SwiftUI

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

    Rapide

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

    Objectif 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'attacher à votre structure App via UIApplicationDelegateAdaptor ou NSApplicationDelegateAdaptor . Vous devez également désactiver le swizzling des délégués d'application. Pour plus d'informations, 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érer des événements de performance pour l'affichage initial des données

Firebase commence à traiter les événements lorsque vous ajoutez avec succès le SDK à votre application. Si vous développez encore localement, interagissez avec votre application pour générer des événements pour la collecte et le traitement initiaux des données.

  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 plusieurs fois votre application entre l'arrière-plan et le premier plan, en interagissant avec votre application en naviguant sur les écrans et/ou en déclenchant des requêtes réseau.

  3. Accédez au tableau de bord des performances de la console Firebase. Vous devriez voir vos données initiales s'afficher dans quelques minutes.

    Si vous ne voyez pas d'affichage de vos données initiales, consultez les conseils de dépannage .

Étape 3 : (Facultatif) Afficher les messages du journal pour les événements de performance

  1. Activez la journalisation de débogage, comme suit :

    1. Dans Xcode (minimum v14.1), sélectionnez Product > Scheme > Edit scheme .
    2. Sélectionnez Exécuter dans le menu de gauche, puis sélectionnez l'onglet Arguments .
    3. Dans la section Arguments transmis au lancement , ajoutez -FIRDebugEnabled .

  2. Vérifiez vos messages de journal pour tout message d'erreur.

  3. La surveillance des performances marque ses messages de journal avec Firebase/Performance afin que vous puissiez filtrer vos messages de journal.

  4. Recherchez les types de journaux suivants qui indiquent que la surveillance des performances consigne 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 performance, 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 qu'il faut à votre application pour effectuer une tâche ou un ensemble de tâches spécifiques, comme le chargement d'un ensemble d'images ou l'interrogation de votre base de données. La métrique par défaut d'un suivi de code personnalisé est sa durée, mais vous pouvez également ajouter des métriques personnalisées, telles que des accès au cache et des avertissements de mémoire.

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

Visitez 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

Après avoir 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 de performances dans le tableau de bord des performances de la console Firebase.

Problèmes connus

  • La surveillance des performances a des problèmes de compatibilité connus avec GTMSQLite. Nous vous recommandons de ne pas utiliser la surveillance des performances avec les applications qui utilisent GTMSQLite.
  • Le basculement de la méthode après l'appel FirebaseApp.configure() peut interférer avec le SDK de surveillance des performances.
  • Des problèmes connus avec le simulateur iOS 8.0-8.2 empêchent la surveillance des performances de 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 de NSURLSession afficheront des temps de connexion plus longs que prévu. Ces connexions sont exécutées hors processus et les minutages reflètent les événements de rappel in-process.

Prochaines étapes