Iniziare a utilizzare Performance Monitoring per Android

Prima di iniziare

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

Passaggio 1: aggiungi l'SDK Performance Monitoring alla tua app

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

1. Nel file Gradle del modulo (a livello di app) (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), aggiungi la dipendenza per la libreria Performance Monitoring per Android. Ti consigliamo di utilizzare Firebase Android BoM per controllare la versione della libreria.

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

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

   (Alternativa)  Aggiungi le dipendenze della libreria Firebase senza utilizzare il file BoM

   Se scegli di non utilizzare Firebase BoM, devi specificare ogni versione della libreria Firebase nella relativa riga di dipendenza.

   Tieni presente che se nella tua app utilizzi più librerie Firebase, ti consigliamo vivamente di utilizzare BoM per gestire le versioni delle librerie, in modo da garantire la compatibilità di tutte le versioni.

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

   Cerchi un modulo della libreria specifico per Kotlin? A partire da ottobre 2023 (Firebase BoM 32.5.0), sia gli sviluppatori Kotlin sia quelli Java possono fare affidamento sul modulo della libreria principale (per maggiori dettagli, consulta le Domande frequenti su questa iniziativa).

2. Ricompila l'app.

Nota: quando aggiungi l'SDK Performance Monitoring alla tua app, l'SDK Remote Config viene incluso come dipendenza. Se utilizzi già Remote Config, non noterai alcuna differenza. Tuttavia, se non hai mai utilizzato Remote Config, consulta la documentazione di Remote Config per saperne di più sulle varie funzionalità a cui potrai accedere nella tua app.

Passaggio 2: aggiungi il plug-in Performance Monitoring Gradle alla tua app

Dopo aver aggiunto il Performance Monitoringplug-in Gradle, Firebase inizia automaticamente a raccogliere i dati per le richieste di rete HTTP/S. Il plug-in consente inoltre di eseguire l'instrumentazione delle tracce di codice personalizzato utilizzando l'annotazione@AddTrace.

Come funziona il plug-in Performance Monitoring

Prima che il codice venga convertito in file DEX, il plug-in Performance Monitoring utilizza l'API Transform e il framework di misurazione del codice bytecode ASM per visitare i file di classe compilati dell'app e per misurare le prestazioni. Il tempo necessario per eseguire l'instrumentazione del codice dipende in gran parte dal numero e dalle dimensioni delle classi.

Se la compilazione dell'app richiede più tempo del previsto, valuta le seguenti opzioni:

• Disattiva il plug-in Performance Monitoring per le build di debug in fase di compilazione
• Modula il codice per ottimizzare la velocità di compilazione

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

   Kotlin

   Stai ancora utilizzando la sintassi buildscript? Scopri come aggiungere plug-in Firebase utilizzando questa sintassi.

   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.2" apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id("com.google.firebase.firebase-perf") version "1.4.2" apply false
   }
   

   Groovy

   Stai ancora utilizzando la sintassi buildscript? Scopri come aggiungere plug-in Firebase utilizzando questa sintassi.

   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.2' 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 modulo (a livello di app) (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), aggiungi il plug-in Gradle Performance Monitoring:

   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 l'app.

Passaggio 3: genera eventi sul rendimento per la visualizzazione dei dati iniziali

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 ed elaborazione iniziale dei dati.

Nota: l'SDK Performance Monitoring raggruppa gli eventi localmente e poi li invia a Firebase periodicamente (ogni 30 secondi). Pertanto, esiste un ritardo tra un'interazione con l'app e il momento in cui Firebase riceve le informazioni sull'evento dalla tua app.

1. Genera eventi spostando l'app tra primo piano e sfondo diverse volte, interagendo con l'app spostandoti tra le schermate e/o attivando richieste di rete.

2. Vai alla dashboard Rendimento della console Firebase. Dovresti visualizzare i dati iniziali entro qualche minuto.

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

Passaggio 4: (Facoltativo) visualizza i messaggi di log per gli eventi relativi al rendimento

1. Attiva il logging di debug per Performance Monitoring in fase di compilazione aggiungendo un elemento <meta-data> al file AndroidManifest.xml della tua app, come segue:

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

2. Controlla se nei messaggi di log sono presenti messaggi di errore.

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

   adb logcat -s FirebasePerformance

4. Controlla la presenza dei seguenti tipi di log che indicano che Performance Monitoring sta registrando 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 dati nella console Firebase. Potrebbero essere necessari alcuni momenti prima che i dati vengano aggiornati nella dashboard.

Se la tua app non registra gli eventi sul rendimento, 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 codice specifico nella tua app, puoi instrumentare le tracce di codice personalizzato.

Con una traccia di codice personalizzata, puoi misurare il tempo necessario alla tua app per completare un'attività o un insieme di attività specifiche, ad esempio il caricamento di un insieme di immagini o l'esecuzione di query sul tuo database. La metrica predefinita per una traccia di codice personalizzato è la durata, ma puoi anche aggiungere metriche personalizzate, come hit della cache e avvisi di memoria.

Nel codice, definisci l'inizio e la fine di una traccia di codice personalizzata (e aggiungi le metriche personalizzate che preferisci) utilizzando l'API fornita dall'SDK Performance Monitoring. Per le app per Android, puoi anche monitorare la durata di metodi specifici utilizzando l'annotazione@AddTrace.

Consulta Aggiungere il monitoraggio per codice specifico per scoprire di più su queste funzionalità e su come aggiungerle alla tua app.

Passaggio 6: esegui il deployment dell'app e poi esamina i risultati

Dopo aver convalidato Performance Monitoring utilizzando uno o più dispositivi di test, puoi eseguire il deployment della versione aggiornata dell'app per i tuoi utenti.

Puoi monitorare i dati sul rendimento nella dashboard Rendimento della console Firebase.

Problemi noti

• Il plug-in Gradle Performance Monitoring versione 1.1.0 può causare una mancata corrispondenza nelle dipendenze di Guava, con il seguente errore:

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

  Se viene visualizzato questo errore, puoi:

  • Esegui l'upgrade del plug-in Performance Monitoring alla versione 1.1.1 o successiva (la più recente è la v1.4.2).

  • Sostituisci la riga di dipendenza del plug-in Performance Monitoring nel file Gradle (<project>/build.gradle.kts o <project>/build.gradle) a livello di root (a livello di progetto) 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'
        }
      }
    }
    

• Performance Monitoring indica la dimensione totale del payload per le richieste di rete HTTP in base al valore impostato nell'intestazione content-length HTTP. Questo valore potrebbe non essere sempre preciso.

• Performance Monitoring supporta solo il processo principale nelle app Android multi-processo.

Passaggi successivi

• Rivedi ed esegui il Performance Monitoring codice di esempio per Android su GitHub.

• Scopri di più sui dati raccolti automaticamente da Performance Monitoring:

  • Dati relativi al ciclo di vita dell'app, ad esempio l'ora di inizio dell'app
  • Dati per il rendering dello schermo nella tua app
  • Dati relativi alle richieste di rete HTTP/S inviate dalla tua app

• Visualizza, monitora e filtra i dati sul rendimento nella console Firebase.

• Aggiungi il monitoraggio di attività o flussi di lavoro specifici nella tua app strumentando le tracce di codice personalizzato.

• Utilizza gli attributi per filtrare i dati sul rendimento.