Disattiva Firebase Performance Monitoring


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

Ad esempio, disattivando Performance Monitoring durante il processo di build dell'app, puoi:

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

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

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

Puoi anche creare la tua app con Performance Monitoring attivato, ma utilizza Firebase Remote Config per avere la flessibilità di disattivare (e riattivare) Performance Monitoring nella tua app di produzione. Con questa opzione, puoi anche configurare la tua app in modo che gli utenti possano attivare o disattivare l'utilizzo di Performance Monitoring.

Disattiva Performance Monitoring durante il processo di creazione dell'app

Puoi disattivare Performance Monitoring durante il processo di build 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é la strumentazione del plug-in può contribuire ad aumentare il tempo di build. Tuttavia, potresti prendere in considerazione di mantenere la libreria abilitata 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é di eventuali tracce di codice personalizzate nella tua app.

Disattiva il plug-in Gradle Performance Monitoring

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

  • Extension Property: disattiva il plug-in per una variante di compilazione specifica in fase di compilazione

  • Proprietà del progetto: disattiva il plug-in per tutte le varianti di build in fase di compilazione

Disattiva il plug-in tramite un flag Extension Property

Utilizzando un flag Extensions Property, puoi disattivare il plug-in Performance Monitoring per una variante di compilazione specifica in fase di compilazione.

  1. Nel file Gradle a livello di directory principale (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 compilazione specifica, ma il contributo al tempo di 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
          }
        }
      }
    }

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

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

Aggiungi il seguente flag 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 libreria Android Performance Monitoring

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

Disattiva la libreria in tempo di compilazione, ma consenti alla tua app di attivarla in tempo 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 alla tua app di attivarla in fase di runtime

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>

Disattiva l'app in fase di runtime utilizzando Remote Config

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

Per disattivare la raccolta dei dati di Performance Monitoring al successivo avvio dell'app per Android, utilizza il codice di esempio riportato di seguito. Per saperne di più sull'utilizzo di Remote Config in un'app per Android, consulta Utilizza 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

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

    Java

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

    Kotlin

    // 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

    // 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, quindi imposta il relativo valore su true.

    Questa modifica renderà le chiamate all'SDK Performance Monitoring chiamate "no operation" (NOOP), eliminando qualsiasi effetto significativo sulle prestazioni dell'app derivante dall'utilizzo dell'SDK Performance Monitoring nella tua app.

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