Inizia con il monitoraggio delle prestazioni per Android

Prima di iniziare

Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android .

Passaggio 1 : aggiungi l'SDK di monitoraggio delle prestazioni alla tua app

Dopo aver aggiunto l'SDK Performance Monitoring, Firebase inizia automaticamente a raccogliere i dati per il rendering dello schermo dell'app e i dati relativi al ciclo di vita dell'app (come l'ora di inizio dell'app ). Per consentire a Firebase di monitorare le richieste di rete, devi anche aggiungere il plug-in Performance Monitoring Gradle (passaggio successivo).

  1. Nel file Gradle del tuo modulo (a livello di app) (solitamente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi la dipendenza per il monitoraggio delle prestazioni libreria per Android. Ti consigliamo di utilizzare la distinta base Android Firebase per controllare il controllo delle versioni della libreria.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.2"))
    
        // 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")
    }
    

    Utilizzando la distinta base Firebase per Android , la tua app utilizzerà sempre le versioni compatibili delle librerie Firebase Android.

    (Alternativa) Aggiungi le dipendenze della libreria Firebase senza utilizzare la distinta base

    Se scegli di non utilizzare la distinta base Firebase, devi specificare ciascuna versione della libreria Firebase nella relativa riga di dipendenza.

    Tieni presente che se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la distinta base per gestire le versioni della libreria, il che garantisce che tutte le versioni siano compatibili.

    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.2")
    }
    
    Cerchi un modulo di libreria specifico per Kotlin? A partire da ottobre 2023 (Firebase BoM 32.5.0) , sia gli sviluppatori Kotlin che quelli Java potranno dipendere dal modulo della libreria principale (per i dettagli, vedere le FAQ su questa iniziativa ).

  2. Ricompila la tua app.

Passaggio 2 : aggiungi il plug-in Gradle di monitoraggio delle prestazioni alla tua app

Dopo aver aggiunto il plug-in Performance Monitoring Gradle, Firebase avvia automaticamente la raccolta dei dati per le richieste di rete HTTP/S . Il plug-in consente inoltre di strumentare tracce di codice personalizzate utilizzando l'annotazione @AddTrace .

  1. Nel file Gradle a livello di root (a livello di progetto) ( <project>/build.gradle.kts o <project>/build.gradle ), aggiungi il plug-in Gradle Performance Monitoring:

    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.1" 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.1' apply false
    
        // Add the dependency for the Performance Monitoring Gradle plugin
        id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
    }
    
  2. Nel file Gradle del tuo modulo (a livello di app) (solitamente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi il plugin Performance Monitoring Gradle:

    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. Ricompila la tua app.

Passaggio 3 : generare eventi prestazionali per la visualizzazione iniziale dei dati

Firebase inizia a elaborare gli eventi quando aggiungi correttamente l'SDK alla tua app. Se stai ancora sviluppando localmente, interagisci con la tua app per generare eventi per la raccolta e l'elaborazione iniziali dei dati.

  1. Genera eventi spostando più volte l'app dallo sfondo al primo piano, interagendo con l'app navigando tra le schermate e/o attivando richieste di rete.

  2. Vai alla dashboard Prestazioni della console Firebase. Dovresti visualizzare i dati iniziali entro pochi minuti.

    Se non vedi la visualizzazione dei dati iniziali, consulta i suggerimenti per la risoluzione dei problemi .

Passaggio 4 : (facoltativo) visualizzare i messaggi di registro per gli eventi di prestazione

  1. Abilita la registrazione del debug per il monitoraggio delle prestazioni in fase di creazione aggiungendo un elemento <meta-data> al file AndroidManifest.xml della tua app, in questo modo:

    <application>
        <meta-data
          android:name="firebase_performance_logcat_enabled"
          android:value="true" />
    </application>
    
  2. Controlla i messaggi di registro per eventuali messaggi di errore.

  3. Performance Monitoring tagga i suoi messaggi di log con FirebasePerformance . Utilizzando il filtro logcat, puoi visualizzare in modo specifico la traccia della durata e la registrazione delle richieste di rete HTTP/S eseguendo il comando seguente:

    adb logcat -s FirebasePerformance
  4. Verificare la presenza dei seguenti tipi di log che indicano che il monitoraggio delle prestazioni registra gli eventi relativi alle prestazioni:

    • Logging trace metric: TRACE_NAME , FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL
  5. Fai clic sull'URL per visualizzare i tuoi dati nella console Firebase. Potrebbero essere necessari alcuni istanti affinché i dati vengano aggiornati nella dashboard.

Se la tua app non registra gli eventi relativi alle prestazioni, consulta i suggerimenti per la risoluzione dei problemi .

Passaggio 5 : (facoltativo) aggiungi il monitoraggio personalizzato per un codice specifico

Per monitorare i dati sulle prestazioni associati a un codice specifico nella tua app, puoi strumentare le tracce del codice personalizzato .

Con una traccia del codice personalizzata, puoi misurare il tempo impiegato dalla tua app per completare un'attività specifica o una serie di attività, ad esempio il caricamento di una serie di immagini o l'esecuzione di query sul database. La metrica predefinita per una traccia del codice personalizzato è la sua durata, ma puoi anche aggiungere metriche personalizzate, come riscontri nella cache e avvisi di memoria.

Nel tuo codice, definisci l'inizio e la fine di una traccia di codice personalizzato (e aggiungi eventuali metriche personalizzate desiderate) utilizzando l'API fornita da Performance Monitoring SDK. Per le app Android, puoi anche monitorare la durata di metodi specifici utilizzando l'annotazione @AddTrace .

Visita Aggiungi monitoraggio per codice specifico per ulteriori informazioni su queste funzionalità e su come aggiungerle alla tua app.

Passaggio 6 : distribuisci la tua app, quindi esamina i risultati

Dopo aver convalidato il monitoraggio delle prestazioni utilizzando uno o più dispositivi di test, puoi distribuire la versione aggiornata della tua app ai tuoi utenti.

Puoi monitorare i dati sulle prestazioni nel dashboard Prestazioni della console Firebase.

Problemi conosciuti

  • Il plugin Performance Monitoring Gradle v1.1.0 può causare una mancata corrispondenza nelle dipendenze Guava, risultando nel seguente errore:

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

    Se visualizzi questo errore, puoi:

    • Aggiorna il plugin Performance Monitoring alla versione 1.1.1 o successiva (la più recente è la versione 1.4.2).

    • Sostituisci la riga di dipendenza del plug-in Performance Monitoring nel file Gradle a livello di root (a livello di progetto) ( <project>/build.gradle.kts o <project>/build.gradle ), come segue:

      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'
          }
        }
      }
      
  • Il monitoraggio delle prestazioni segnala la dimensione totale del payload per le richieste di rete HTTP in base al valore impostato nell'intestazione HTTP content-length. Questo valore potrebbe non essere sempre accurato.

  • Il monitoraggio delle prestazioni supporta solo il processo principale nelle app Android multiprocesso.

Prossimi passi