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 di monitoraggio delle prestazioni, 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. Utilizzando Firebase Android BoM , dichiara la dipendenza per la libreria Android Performance Monitoring nel file Gradle del tuo modulo (a livello di app (di solito app/build.gradle ).

    Java

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

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

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

    Se scegli di non utilizzare la distinta base di 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 delle librerie, il che garantisce che tutte le versioni siano compatibili.

    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.1.0'
    }
    

    Kotlin+KTX

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

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

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

    Se scegli di non utilizzare la distinta base di 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 delle librerie, il che garantisce che tutte le versioni siano compatibili.

    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.1.0'
    }
    

  2. Ricompila la tua app.

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

Dopo aver aggiunto il plug-in Performance Monitoring Gradle, Firebase inizia automaticamente a raccogliere 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 del tuo modulo (a livello di app) (di solito app/build.gradle ), applica il plug-in di monitoraggio delle prestazioni:

    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. Nel tuo file Gradle a livello di root (a livello di progetto) ( build.gradle ), aggiungi le regole per includere il plug-in di monitoraggio delle prestazioni.

    buildscript {
    
        repositories {
          // Check that you have the following lines (if not, add them):
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
    
        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.13'  // Google Services plugin
    
          // Add the dependency for the Performance Monitoring plugin
          classpath 'com.google.firebase:perf-plugin:1.4.1'  // Performance Monitoring plugin
        }
    }
    
  3. Ricompila la tua app.

Passaggio 3 : generare eventi di prestazioni 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 dei dati iniziali.

  1. Genera eventi spostando più volte la tua app tra lo sfondo e il primo piano, interagendo con la tua app navigando tra le schermate e/o attivando richieste di rete.

  2. Vai alla dashboard delle prestazioni della console Firebase. Dovresti vedere i tuoi dati iniziali visualizzati entro pochi minuti.

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

Passaggio 4 : (facoltativo) visualizzare i messaggi di registro per gli eventi relativi alle prestazioni

  1. Abilita la registrazione del debug per il monitoraggio delle prestazioni in fase di compilazione 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 registro 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 sta registrando gli eventi delle 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. L'aggiornamento dei dati nella dashboard potrebbe richiedere alcuni istanti.

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 codice specifico

Per monitorare i dati sulle prestazioni associati a codice specifico nella tua app, puoi strumentare tracce di codice personalizzate .

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

Nel codice, definisci l'inizio e la fine di una traccia del codice personalizzato (e aggiungi le metriche personalizzate desiderate) utilizzando l'API fornita dall'SDK di monitoraggio delle prestazioni. 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 rivedi 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 nella dashboard delle prestazioni della console Firebase.

Problemi noti

  • Il plug-in Performance Monitoring Gradle v1.1.0 può causare una mancata corrispondenza nelle dipendenze Guava, causando il seguente errore:

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

    Se vedi questo errore, puoi:

    • Aggiorna il plug-in Performance Monitoring alla v1.1.1 o successiva (la più recente è la v1.4.1).

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

      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 riporta la dimensione totale del carico utile per le richieste di rete HTTP in base al valore impostato nell'intestazione della lunghezza del contenuto HTTP. Questo valore potrebbe non essere sempre accurato.

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

Prossimi passi