Catch up on everything we announced at this year's Firebase Summit. Learn more

Erste Schritte mit Leistungsüberwachung für Android

Bevor Sie beginnen

Wenn Sie nicht bereits haben, fügen Sie Firebase zu dem Android - Projekt .

Schritt 1: Fügen Sie die Performance - Monitoring - SDK in Ihre App

Nachdem Sie das Performance - Monitoring - SDK hinzugefügt haben, Firebase startet automatisch Daten für App-Sammelbild - Wiedergabe und Daten im Zusammenhang mit Ihrer App Lifecycle (wie App - Startzeit ). Um Firebase zu ermöglichen, Netzwerkanforderungen zu überwachen, müssen Sie auch die Performance - Überwachung Gradle Plugin (nächster Schritt) hinzuzufügen.

  1. Mit Hilfe der Firebase Android BoM , erklärt die Abhängigkeit für die Leistungsüberwachung Android - Bibliothek in Ihrem Modul (app-Ebene) Gradle Datei ( in der Regel app/build.gradle ).

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.1')
    
        // Declare the dependency for the Performance Monitoring library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-perf'
    }
    

    Durch die Verwendung des Firebase Android BoM werden, Ihre App immer kompatible Versionen der Firebase Android - Bibliotheken verwenden.

    (Alternative) Deklarieren Firebase Bibliothek Abhängigkeiten , ohne die BoM mit

    Wenn Sie die Firebase-Stückliste nicht verwenden möchten, müssen Sie jede Firebase-Bibliotheksversion in ihrer Abhängigkeitszeile angeben.

    Beachten Sie, dass , wenn Sie mehrere Firebase Bibliotheken in Ihrer Anwendung verwenden wir mit der BoM empfehlen Bibliothek Versionen zu verwalten, die sicherstellt , dass alle Versionen kompatibel sind.

    dependencies {
        // Declare the dependency for the Performance Monitoring library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-perf:20.0.4'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.1')
    
        // Declare the dependency for the Performance Monitoring library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-perf-ktx'
    }
    

    Durch die Verwendung des Firebase Android BoM werden, Ihre App immer kompatible Versionen der Firebase Android - Bibliotheken verwenden.

    (Alternative) Deklarieren Firebase Bibliothek Abhängigkeiten , ohne die BoM mit

    Wenn Sie die Firebase-Stückliste nicht verwenden möchten, müssen Sie jede Firebase-Bibliotheksversion in ihrer Abhängigkeitszeile angeben.

    Beachten Sie, dass , wenn Sie mehrere Firebase Bibliotheken in Ihrer Anwendung verwenden wir mit der BoM empfehlen Bibliothek Versionen zu verwalten, die sicherstellt , dass alle Versionen kompatibel sind.

    dependencies {
        // Declare the dependency for the Performance Monitoring library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-perf-ktx:20.0.4'
    }
    

  2. Kompilieren Sie Ihre App neu.

Schritt 2: Fügen Sie die Performance - Monitoring - Plugin , um Ihre Anwendung

Nachdem Sie die Performance - Überwachung Gradle Plugin hinzugefügt haben, Firebase startet automatisch Daten für das Sammeln von HTTP / S Netzwerkanforderungen . Das Plugin ermöglicht es Ihnen , auch zum Instrument benutzerdefinierten Code Spuren mit @AddTrace Anmerkung .

  1. In Ihrem Modul (app-Ebene) Gradle Datei ( in der Regel app/build.gradle ), gilt die Leistungsüberwachung Plugin:

    apply plugin: 'com.android.application'
    apply plugin: 'com.google.gms.google-services'
    // Apply the Performance Monitoring plugin
    apply plugin: 'com.google.firebase.firebase-perf'
    
    android {
      // ...
    }
    
  2. In Ihrer Root-Ebene (Projektebene) Gradle Datei ( build.gradle ), fügen Sie die Regeln für die Leistungsüberwachung Plugin enthält.

    buildscript {
    
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // Add the Bintray repository
          jcenter()
        }
    
        dependencies {
          // ...
    
          // To benefit from the latest Performance Monitoring plugin features,
          // update your Android Gradle Plugin dependency to at least v3.4.0
          classpath 'com.android.tools.build:gradle:3.4.0'
    
          classpath 'com.google.gms:google-services:4.3.10'  // Google Services plugin
    
          // Add the dependency for the Performance Monitoring plugin
          classpath 'com.google.firebase:perf-plugin:1.4.0'  // Performance Monitoring plugin
        }
    }
    
  3. Kompilieren Sie Ihre App neu.

Schritt 3: Generieren Leistungsereignisse für die anfängliche Datenanzeige

Firebase beginnt mit der Verarbeitung der Ereignisse, wenn Sie das SDK erfolgreich zu Ihrer App hinzugefügt haben. Wenn Sie noch lokal entwickeln, interagieren Sie mit Ihrer App, um Ereignisse für die anfängliche Datenerfassung und -verarbeitung zu generieren.

  1. Generieren Sie Ereignisse, indem Sie Ihre App mehrmals zwischen Hintergrund und Vordergrund wechseln, mit Ihrer App interagieren, indem Sie über Bildschirme navigieren und/oder Netzwerkanfragen auslösen.

  2. Gehen Sie auf die Performance - Dashboard der Konsole Firebase. Sie sollten innerhalb weniger Minuten Ihre erste Datenanzeige sehen.

    Wenn Sie nicht über eine Anzeige Ihrer ersten Daten, die überprüfen Tipps zur Fehlerbehebung .

Schritt 4: (Optional) Ansicht Log - Meldungen für Performance - Events

  1. Aktivieren Sie die Debug - Protokollierung für die Leistungsüberwachung bei der Erstellung durch das Hinzufügen eines <meta-data> Elements zu Ihrer App AndroidManifest.xml Datei, etwa so:

    <application>
        <meta-data
          android:name="firebase_performance_logcat_enabled"
          android:value="true" />
    </application>
    
  2. Überprüfen Sie Ihre Protokollnachrichten auf Fehlermeldungen.

  3. Performance Monitoring - Tags seine Log - Meldungen mit FirebasePerformance . Mit der Logcat-Filterung können Sie die Ablaufverfolgung und die HTTP/S-Netzwerkanforderungsprotokollierung gezielt anzeigen, indem Sie den folgenden Befehl ausführen:

    adb logcat -s FirebasePerformance
  4. Suchen Sie nach den folgenden Protokolltypen, die darauf hinweisen, dass die Leistungsüberwachung Leistungsereignisse protokolliert:

    • Logging trace metric: TRACE_NAME , FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL
  5. Klicken Sie auf die URL, um Ihre Daten in der Firebase-Konsole anzuzeigen. Es kann einen Moment dauern, bis die Daten im Dashboard aktualisiert werden.

Wenn Ihre App nicht Performance - Events anmelden, die überprüfen Tipps zur Fehlerbehebung .

Schritt 5: (Optional) Fügen Sie die Überwachung speziell für spezifischen Code

Leistungsdaten mit spezifischem Code in Ihrer Anwendung verbunden zu überwachen, können Sie Instrument benutzerdefinierten Code Spuren .

Mit einer benutzerdefinierten Codeablaufverfolgung können Sie messen, wie lange Ihre App benötigt, um eine bestimmte Aufgabe oder einen Satz von Aufgaben abzuschließen, z. B. das Laden einer Reihe von Bildern oder das Abfragen Ihrer Datenbank. Die Standardmetrik für einen benutzerdefinierten Codetrace ist die Dauer, aber Sie können auch benutzerdefinierte Metriken wie Cache-Treffer und Speicherwarnungen hinzufügen.

In Ihrem Code definieren Sie den Anfang und das Ende eines benutzerdefinierten Code-Trace (und fügen beliebige benutzerdefinierte Metriken hinzu), indem Sie die vom Performance Monitoring SDK bereitgestellte API verwenden. Bei Android - Apps können Sie auch die Dauer der spezifischen Methoden überwachen @AddTrace Anmerkung .

Besuche hinzu spezifische Code Überwachung mehr über diese Funktionen zu erfahren , und wie sie zu Ihrer Anwendung hinzuzufügen.

Schritt 6: Stellen Sie Ihre App dann als Ergebnis hieraus

Nachdem Sie die Leistungsüberwachung mit einem oder mehreren Testgeräten validiert haben, können Sie die aktualisierte Version Ihrer App für Ihre Benutzer bereitstellen.

Sie können Leistungsdaten in der Überwachung der Performance - Dashboard der Konsole Firebase.

Bekannte Probleme

  • Das Leistungsüberwachungs-Gradle-Plugin v1.1.0 kann eine Nichtübereinstimmung in Guava-Abhängigkeiten verursachen, was zu folgendem Fehler führt:

    Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
    > com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;

    Wenn dieser Fehler angezeigt wird, können Sie entweder:

    • Aktualisieren Sie das Leistungsüberwachungs-Plug-in auf v1.1.1 oder höher (die neueste ist v1.4.0).

    • Ersetzen Sie die Performance - Überwachung Plugin Abhängigkeitszeile in Ihrer Root-Ebene (Projektebene) Gradle Datei ( build.gradle ), wie folgt:

      buildscript {
        // ...
      
        dependencies {
          // ...
      
          // Replace the standard Performance Monitoring plugin dependency line, as follows:
          classpath ('com.google.firebase:perf-plugin:1.1.0') {
                      exclude group: 'com.google.guava', module: 'guava-jdk5'
          }
        }
      }
      
  • Die Leistungsüberwachung meldet die Gesamtnutzlastgröße für HTTP-Netzwerkanforderungen basierend auf dem im HTTP-Content-Length-Header festgelegten Wert. Dieser Wert ist möglicherweise nicht immer genau.

  • Die Leistungsüberwachung unterstützt nur den Hauptprozess in Android-Apps mit mehreren Prozessen.

Nächste Schritte