Beginnen Sie mit der Leistungsüberwachung für Android

Bevor Sie beginnen

Falls noch nicht geschehen, fügen Sie Firebase zu Ihrem Android-Projekt hinzu .

Schritt 1 : Fügen Sie das Performance Monitoring SDK zu Ihrer App hinzu

Nachdem Sie das Performance Monitoring SDK hinzugefügt haben, beginnt Firebase automatisch mit der Erfassung von Daten für die Bildschirmwiedergabe Ihrer App und Daten im Zusammenhang mit dem Lebenszyklus Ihrer App (z. B. App-Startzeit ). Damit Firebase Netzwerkanfragen überwachen kann, müssen Sie auch das Performance Monitoring Gradle-Plugin hinzufügen (nächster Schritt).

  1. Fügen Sie in Ihrer Modul-Gradle-Datei (auf App-Ebene) (normalerweise <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle ) die Abhängigkeit für die Leistungsüberwachung hinzu Bibliothek für Android. Wir empfehlen die Verwendung der Firebase Android BoM zur Steuerung der Bibliotheksversionierung.

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:32.6.0"))

    // Add 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 der Firebase Android BoM verwendet Ihre App immer kompatible Versionen der Firebase Android-Bibliotheken.

    (Alternative) Fügen Sie Firebase-Bibliotheksabhängigkeiten hinzu , ohne die Stückliste zu verwenden

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

    Beachten Sie: Wenn Sie mehrere Firebase-Bibliotheken in Ihrer App verwenden, empfehlen wir dringend, die BoM zum Verwalten der Bibliotheksversionen zu verwenden, um sicherzustellen, dass alle Versionen kompatibel sind.

    dependencies {
    // Add 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.5.1")
}
    Suchen Sie nach einem Kotlin-spezifischen Bibliotheksmodul? Ab Oktober 2023 (Firebase BoM 32.5.0) können sich sowohl Kotlin- als auch Java-Entwickler auf das Hauptbibliotheksmodul verlassen (Einzelheiten finden Sie in den FAQ zu dieser Initiative ).

  2. Kompilieren Sie Ihre App neu.

Schritt 2 : Fügen Sie das Performance Monitoring Gradle-Plugin zu Ihrer App hinzu

Nachdem Sie das Performance Monitoring Gradle-Plugin hinzugefügt haben, beginnt Firebase automatisch mit der Erfassung von Daten für HTTP/S-Netzwerkanfragen . Mit dem Plugin können Sie auch benutzerdefinierte Code-Traces mithilfe der @AddTrace-Annotation instrumentieren.

  1. Fügen Sie in Ihrer Gradle-Datei auf Stammebene (Projektebene) ( <project>/build.gradle.kts oder <project>/build.gradle ) das Performance Monitoring Gradle-Plugin hinzu:

    Kotlin

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id("com.android.application") version "7.3.0" apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id("com.google.gms.google-services") version "4.4.0" apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf") version "1.4.2" apply false
}

    Groovy

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id 'com.android.application' version '7.3.0' apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id 'com.google.gms.google-services' version '4.4.0' apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
}

  2. Fügen Sie in Ihrer Modul-Gradle-Datei (auf App-Ebene) (normalerweise <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle ) das Performance Monitoring Gradle-Plugin hinzu:

    Kotlin

    plugins {
    id("com.android.application")

    // Make sure that you have the Google services Gradle plugin
    id("com.google.gms.google-services")

    // Add the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf")
    ...
}

    Groovy

    plugins {
    id 'com.android.application'

    // Make sure that you have the Google services Gradle plugin
    id 'com.google.gms.google-services'

    // Add the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf'
    ...
}

  3. Kompilieren Sie Ihre App neu.

Schritt 3 : Leistungsereignisse für die erste Datenanzeige generieren

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 erste 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 zum Performance- Dashboard der Firebase-Konsole. Innerhalb weniger Minuten sollten Sie Ihre erste Datenanzeige sehen.

    Wenn Ihre ursprünglichen Daten nicht angezeigt werden, lesen Sie die Tipps zur Fehlerbehebung .

Schritt 4 : (Optional) Protokollmeldungen für Leistungsereignisse anzeigen

  1. Aktivieren Sie die Debug-Protokollierung für die Leistungsüberwachung zur Erstellungszeit, indem Sie ein <meta-data> -Element zur AndroidManifest.xml Datei Ihrer App hinzufügen, etwa so:

    <application>
    <meta-data
      android:name="firebase_performance_logcat_enabled"
      android:value="true" />
</application>

  2. Überprüfen Sie Ihre Protokollnachrichten auf etwaige Fehlermeldungen.

  3. Performance Monitoring markiert seine Protokollnachrichten mit FirebasePerformance . Mithilfe der Logcat-Filterung können Sie die Protokollierung der Dauerverfolgung und HTTP/S-Netzwerkanforderungen gezielt anzeigen, indem Sie den folgenden Befehl ausführen:

    adb logcat -s FirebasePerformance

  4. Suchen Sie nach den folgenden Protokolltypen, die darauf hinweisen, dass Performance Monitoring 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 keine Leistungsereignisse protokolliert, lesen Sie die Tipps zur Fehlerbehebung .

Schritt 5 : (Optional) Fügen Sie eine benutzerdefinierte Überwachung für bestimmten Code hinzu

Um Leistungsdaten zu überwachen, die einem bestimmten Code in Ihrer App zugeordnet sind, können Sie benutzerdefinierte Code-Traces instrumentieren.

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

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

Besuchen Sie „Überwachung für bestimmten Code hinzufügen“, um mehr über diese Funktionen zu erfahren und wie Sie sie Ihrer App hinzufügen können.

Schritt 6 : Stellen Sie Ihre App bereit und überprüfen Sie dann die Ergebnisse

Nachdem Sie die Leistungsüberwachung mithilfe eines oder mehrerer Testgeräte validiert haben, können Sie Ihren Benutzern die aktualisierte Version Ihrer App bereitstellen.

Sie können Leistungsdaten im Leistungs- Dashboard der Firebase-Konsole überwachen.

Bekannte Probleme

  • Das Performance Monitoring Gradle-Plugin v1.1.0 kann zu einer Nichtübereinstimmung der Guava-Abhängigkeiten führen, 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 Sie diesen Fehler sehen, können Sie entweder:

    • Aktualisieren Sie das Performance Monitoring-Plugin auf Version 1.1.1 oder höher (die neueste Version ist Version 1.4.2).

    • Ersetzen Sie die Abhängigkeitszeile des Performance Monitoring-Plugins in Ihrer Gradle-Datei auf Stammebene (Projektebene) ( <project>/build.gradle.kts oder <project>/build.gradle ) wie folgt:

      Kotlin

      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")
    }
  }
}

      Groovy

      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