Firebase Performance Monitoring deaktivieren


Während der App-Entwicklung und ‑Tests kann es sinnvoll sein, Performance Monitoring zu deaktivieren.

Wenn Sie während des App-Build-Prozesses Performance Monitoring deaktivieren, können Sie beispielsweise Folgendes tun:

  • Bestimmte Funktionen von Performance Monitoring (z. B. die vom Performance Monitoring Gradle-Plug-in) in Ihren Debug-Builds deaktivieren, aber die Funktionen für Ihren Release-Build wieder aktivieren.

  • Performance Monitoring beim Erstellen Ihrer App deaktivieren, aber Ihrer App erlauben, es zur Laufzeit wieder zu aktivieren.

  • Performance Monitoring beim Erstellen Ihrer App deaktivieren und Ihrer App nicht erlauben, es zur Laufzeit wieder zu aktivieren.

Sie können Ihre App auch mit Performance Monitoring aktiviertem erstellen, aber mit Firebase Remote Config die Flexibilität haben, Performance Monitoring in Ihrer Produktions-App zu deaktivieren (und wieder zu aktivieren). Mit dieser Option können Sie Ihre App sogar so konfigurieren, dass Nutzer die Verwendung von Performance Monitoring aktivieren oder deaktivieren können.

Performance Monitoring während des App-Build-Prozesses deaktivieren

Sie können Performance Monitoring während des Build-Prozesses deaktivieren, indem Sie das Performance Monitoring Gradle-Plug-in deaktivieren und/oder indem Sie die Performance Monitoring Android-Bibliothek deaktivieren.

Während der Entwicklung und des Debuggings ist es sinnvoll, das Plug-in zu deaktivieren, da die Instrumentierung durch das Plug-in die Build-Zeit verlängern kann. Sie sollten jedoch die Bibliothek aktiviert lassen, damit Sie weiterhin Leistungsdaten aus App-Start-, App-im-Vordergrund- und App-im-Hintergrund-Traces sowie alle benutzerdefinierten Code-Traces in Ihrer App sehen können.

Performance Monitoring Gradle-Plug-in deaktivieren

Sie können das Performance Monitoring Plug-in deaktivieren, indem Sie mit den folgenden Optionen ein instrumentationEnabled Flag hinzufügen:

Plug-in über ein Flag für die Erweiterungseigenschaft deaktivieren

Mit einem Flag für die Erweiterungseigenschaft können Sie das Performance Monitoring Plug-in zur Kompilierzeit für eine bestimmte Build-Variante deaktivieren.

  1. Prüfen Sie in der Gradle-Datei auf Stammebene (Projektebene) (<project>/build.gradle.kts oder <project>/build.gradle), ob Ihre Android Gradle-Plug-in-Abhängigkeit als Version 3.4.0 oder höher angegeben ist.

    Bei früheren Versionen des Android Gradle-Plug-ins können Sie das Performance Monitoring Plug-in weiterhin für eine bestimmte Build-Variante deaktivieren, aber der Beitrag zur Build-Zeit für diese Variante wird nicht vollständig eliminiert.

  2. Fügen Sie der Gradle-Datei des Moduls (auf Anwendungsebene) (in der Regel <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle) das folgende Flag hinzu und setzen Sie es auf false, um das Performance Monitoring Plug-in zu deaktivieren.

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

Plug-in über ein Flag für die Projekteigenschaft deaktivieren

Mit einem Flag für die Projekteigenschaft können Sie das Performance Monitoring Plug-in zur Kompilierzeit für alle Build-Varianten deaktivieren.

Fügen Sie der Datei gradle.properties das folgende Flag hinzu und setzen Sie es auf false, um das Performance Monitoring Plug-in zu deaktivieren.

// ...

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

Performance Monitoring Android-Bibliothek deaktivieren

Wenn Sie die Performance Monitoring Bibliothek zur Kompilierzeit deaktivieren, können Sie festlegen, ob Ihre App die Bibliothek zur Laufzeit aktivieren darf.

Bibliothek zur Kompilierzeit deaktivieren, aber Ihrer App erlauben, sie zur Laufzeit zu aktivieren

Fügen Sie der Datei AndroidManifest.xml Ihrer App das folgende <meta-data>-Element hinzu:

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

Bibliothek zur Kompilierzeit deaktivieren und Ihrer App nicht erlauben, sie zur Laufzeit zu aktivieren

Fügen Sie der Datei AndroidManifest.xml Ihrer App das folgende <meta-data>-Element hinzu:

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

App zur Laufzeit mit Remote Config deaktivieren

Firebase Remote Config ermöglicht es Ihnen, Änderungen am Verhalten und Erscheinungsbild Ihrer App vorzunehmen. Daher ist es eine ideale Möglichkeit, Performance Monitoring in bereitgestellten Instanzen Ihrer App zu deaktivieren.

Wenn Sie die Erfassung von Performance Monitoring Daten beim nächsten Start Ihrer Android-App deaktivieren möchten, verwenden Sie den unten gezeigten Beispielcode. Weitere Informationen zur Verwendung von Remote Config in einer Android-App finden Sie unter Use Firebase Remote Config on Android.

  1. Prüfen Sie, ob Remote Config im Abschnitt dependencies der Gradle-Datei des Moduls (auf Anwendungsebene) (in der Regel <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle) enthalten ist:

    Kotlin

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

    Java

      implementation("com.google.firebase:firebase-config:23.0.1")
    
  2. Richten Sie Remote Config ein und deaktivieren Sie Performance Monitoring, wenn perf_disable auf true gesetzt ist:

    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. Fügen Sie MainActivity.java den folgenden Code hinzu, um Remote Config-Werte abzurufen und zu aktivieren Remote Config Werte:

    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. Wenn Sie Performance Monitoring in der Firebase Console deaktivieren möchten, erstellen Sie im Projekt Ihrer App einen perf_disable Parameter und setzen Sie seinen Wert auf true.

    Durch diese Änderung werden Aufrufe des Performance Monitoring SDK zu „No-Operation“-Aufrufen (NOOPs), wodurch sich die Verwendung des Performance Monitoring SDK in Ihrer App nicht mehr wesentlich auf die App-Leistung auswirkt.

    Wenn Sie den Wert von perf_disable auf false setzen, bleibt Performance Monitoring aktiviert.