Disattiva Firebase Performance Monitoring


Durante lo sviluppo e i test delle app, potrebbe essere utile disattivare Performance Monitoring.

Ad esempio, disattivando Performance Monitoring durante la procedura di compilazione dell'app, puoi:

  • Disattiva determinate funzionalità di Performance Monitoring (ad esempio quelle fornite dal Performance Monitoring plug-in Gradle) nelle build di debug, ma riattivale per la build di release.

  • Disattiva Performance Monitoring durante la creazione dell'app, ma consenti all'app di riattivarla in fase di runtime.

  • Disattiva Performance Monitoring durante la creazione dell'app e non consentire all'app di riattivarlo in fase di runtime.

Puoi anche creare l'app con Performance Monitoring abilitato, ma utilizzare Firebase Remote Config per avere la flessibilità di disattivare (e riattivare) Performance Monitoring nell'app di produzione. Con questa opzione, puoi anche configurare l'app in modo da consentire agli utenti di attivare o disattivare l'utilizzo di Performance Monitoring.

Disattiva Performance Monitoring durante il processo di compilazione dell'app

Puoi disattivare Performance Monitoring durante il processo di compilazione disattivando il plug-in Gradle Performance Monitoring e/o disattivando la libreria Android Performance Monitoring.

Durante lo sviluppo e il debug, la disattivazione del plug-in è utile perché l'instrumentazione del plug-in può contribuire ad aumentare il tempo di compilazione. Tuttavia, ti consigliamo di mantenere attiva la libreria in modo da poter comunque visualizzare i dati sul rendimento delle tracce di avvio dell'app, dell'app in primo piano e dell'app in background, nonché eventuali tracce di codice personalizzato nella tua app.

Disattiva il plug-in Gradle di Performance Monitoring

Puoi disattivare il plug-in Performance Monitoring aggiungendo un flag instrumentationEnabled utilizzando le seguenti opzioni:

  • Proprietà estensione: disattiva il plug-in per una variante di build specifica al momento della compilazione

  • Proprietà del progetto: disattiva il plug-in per tutte le varianti della build al momento della compilazione

Disattiva il plug-in tramite un flag Extension Property

Se utilizzi un flag extensions Property, puoi disattivare il plug-in Performance Monitoring per una variante di build specifica al momento della compilazione.

  1. Nel file Gradle a livello di root (a livello di progetto) (<project>/build.gradle.kts o <project>/build.gradle), assicurati che la dipendenza del plug-in Android per Gradle sia specificata come v3.4.0 o successiva.

    Per le versioni precedenti del plug-in Android per Gradle, puoi comunque disattivare il plug-in Performance Monitoring per una variante di build specifica, ma il contributo al momento della compilazione per quella variante non verrà eliminato completamente.

  2. Aggiungi il seguente flag al file Gradle del modulo (a livello di app) (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), quindi impostalo su false per disattivare il plug-in Performance Monitoring.

    Kotlin

    import com.google.firebase.perf.plugin.FirebasePerfExtension
    
    // ...
    
    android {
      // ...
      buildTypes {
        getByName("debug") {
          configure<FirebasePerfExtension> {
            // Set this flag to 'false' to disable @AddTrace annotation processing and
            // automatic monitoring of HTTP/S network requests
            // for a specific build variant at compile time.
            setInstrumentationEnabled(false)
          }
        }
      }
    }

    Groovy

    android {
      // ...
      buildTypes {
        debug {
          FirebasePerformance {
            // Set this flag to 'false' to disable @AddTrace annotation processing and
            // automatic monitoring of HTTP/S network requests
            // for a specific build variant at compile time.
            instrumentationEnabled false
          }
        }
      }
    }

Disattivare il plug-in tramite un flag della proprietà del progetto

Utilizzando un flag Proprietà progetto, puoi disattivare il plug-in Performance Monitoring per tutte le varianti di compilazione in fase di compilazione.

Aggiungi il flag seguente al file gradle.properties, quindi impostalo su false per disattivare il plug-in Performance Monitoring.

// ...

// Set this flag to 'false' to disable @AddTrace annotation processing and
// automatic monitoring of HTTP/S network requests
// for all build variants at compile time.
firebasePerformanceInstrumentationEnabled=false

Disattiva la raccolta Android Performance Monitoring

Se disattivi la libreria Performance Monitoring in fase di compilazione, puoi scegliere se consentire alla tua app di attivarla in fase di esecuzione.

Disattiva la libreria in fase di compilazione, ma consenti alla tua app di attivarla in fase di esecuzione

Aggiungi il seguente elemento <meta-data> al file AndroidManifest.xml della tua app:

  <application>
    <meta-data
      android:name="firebase_performance_collection_enabled"
      android:value="false" />
  </application>

Disattiva la libreria in fase di compilazione, ma non consentire all'app di attivarla in fase di esecuzione

Aggiungi il seguente elemento <meta-data> al file AndroidManifest.xml della tua app:

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

Disattivare l'app in fase di esecuzione utilizzando Remote Config

Firebase Remote Config ti consente di apportare modifiche al comportamento e all'aspetto della tua app, pertanto è un modo ideale per disattivare Performance Monitoring nelle istanze di cui è stato eseguito il deployment.

Per disattivare la raccolta dei dati di Performance Monitoring alla successiva avviata dell'app Android, utilizza il codice di esempio riportato di seguito. Per maggiori informazioni sull'utilizzo di Remote Config in un'app per Android, vedi Utilizzare Firebase Remote Config su Android.

  1. Assicurati che Remote Config sia nella sezione dependencies del file Gradle del modulo (a livello di app) (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle):

    Kotlin+KTX

      implementation("com.google.firebase:firebase-config-ktx:22.0.1")
    

    Java

      implementation("com.google.firebase:firebase-config:22.0.1")
    
  2. Configura Remote Config e disabilita Performance Monitoring se perf_disable è impostato su true:

    Kotlin+KTX

    // Setup remote config
    val config = Firebase.remoteConfig
    
    // You can uncomment the following two statements to permit more fetches when
    // validating your app, but you should comment out or delete these lines before
    // distributing your app in production.
    // val configSettings = remoteConfigSettings {
    //     minimumFetchIntervalInSeconds = 3600
    // }
    // config.setConfigSettingsAsync(configSettings)
    // Load in-app defaults from an XML file that sets perf_disable to false until you update
    // values in the Firebase Console
    
    // Observe the remote config parameter "perf_disable" and disable Performance Monitoring if true
    config.setDefaultsAsync(R.xml.remote_config_defaults)
        .addOnCompleteListener { task ->
            if (task.isSuccessful) {
                Firebase.performance.isPerformanceCollectionEnabled = !config.getBoolean("perf_disable")
            } else {
                // An error occurred while setting default parameters
            }
        }

    Java

    // Setup remote config
    final FirebaseRemoteConfig config = FirebaseRemoteConfig.getInstance();
    
    // You can uncomment the following two statements to permit more fetches when
    // validating your app, but you should comment out or delete these lines before
    // distributing your app in production.
    // FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
    //       .setMinimumFetchIntervalInSeconds(3600)
    //       .build();
    // config.setConfigSettingsAsync(configSettings);
    // Load in-app defaults from an XML file that sets perf_disable to false until you update
    // values in the Firebase Console
    
    //Observe the remote config parameter "perf_disable" and disable Performance Monitoring if true
    config.setDefaultsAsync(R.xml.remote_config_defaults)
            .addOnCompleteListener(new OnCompleteListener<Void>() {
                @Override
                public void onComplete(@NonNull Task<Void> task) {
                    if (task.isSuccessful()) {
                        if (config.getBoolean("perf_disable")) {
                            FirebasePerformance.getInstance().setPerformanceCollectionEnabled(false);
                        } else {
                            FirebasePerformance.getInstance().setPerformanceCollectionEnabled(true);
                        }
                    } else {
                        // An error occurred while setting default parameters
                    }
                }
            });
  3. Aggiungi il seguente codice a MainActivity.java per recuperare e attivare i valori Remote Config:

    Kotlin+KTX

    // Remote Config fetches and activates parameter values from the service
    val config = Firebase.remoteConfig
    config.fetch(3600)
        .continueWithTask { task ->
            if (!task.isSuccessful) {
                task.exception?.let {
                    throw it
                }
            }
            config.activate()
        }
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                // Parameter values successfully activated
                // ...
            } else {
                // Handle errors
            }
        }

    Java

    //Remote Config fetches and activates parameter values from the service
    final FirebaseRemoteConfig config = FirebaseRemoteConfig.getInstance();
    config.fetch(3600)
            .continueWithTask(new Continuation<Void, Task<Boolean>>() {
                @Override
                public Task<Boolean> then(@NonNull Task<Void> task) throws Exception {
                    if (!task.isSuccessful()) {
                        throw task.getException();
                    }
                    return config.activate();
                }
            })
            .addOnCompleteListener(new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    if (task.isSuccessful()) {
                        // Parameter values successfully activated
                        // ...
                    } else {
                        // Handle errors
                    }
                }
            });
  4. Per disattivare Performance Monitoring nella console Firebase, crea un parametro perf_disable nel progetto della tua app e imposta il relativo valore su true.

    Questa modifica comporterà le chiamate "Nessuna operazione" dell'SDK Performance Monitoring (NOOP), eliminando eventuali effetti significativi sulle prestazioni dell'app in seguito all'utilizzo dell'SDK Performance Monitoring nella tua app.

    Se imposti il valore di perf_disable su false, Performance Monitoring rimane abilitato.