Firebase Performance Monitoring deaktivieren

iOS+ Android Web Flutter

Während der Entwicklung und beim Testen Ihrer App kann es hilfreich sein, Performance Monitoring zu deaktivieren.

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

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

• Deaktivieren Sie Performance Monitoring beim Erstellen Ihrer App, erlauben Sie Ihrer App aber, sie zur Laufzeit wieder zu aktivieren.

• Deaktivieren Sie Performance Monitoring beim Erstellen Ihrer App und verhindern Sie, dass Ihre App sie zur Laufzeit wieder aktiviert.

Sie können Ihre App auch mit Performance Monitoring aktiviert erstellen, aber Firebase Remote Config verwenden, um 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 die Performance Monitoring-Android-Bibliothek deaktivieren.

Während der Entwicklung und des Debuggens ist es nützlich, das Plug-in zu deaktivieren, da die Instrumentierung durch das Plug-in zu einer längeren Build-Zeit beitragen kann. Sie sollten die Bibliothek jedoch aktiviert lassen, damit Sie weiterhin Leistungsdaten aus Traces für App-Start, App im Vordergrund und App im Hintergrund sowie Traces für benutzerdefinierten Code in Ihrer App ansehen können.

Hinweis :Wenn Sie die Bibliothek deaktivieren, das Plug-in aber aktiviert lassen, erfolgt die Instrumentierung weiterhin durch das Plug-in. Alle erhobenen Daten, die mit dem Plug-in verknüpft sind (d. h. @AddTrace-Annotationsverarbeitung und automatische Überwachung von HTTP/S-Netzwerkanfragen), werden jedoch nicht für Leistungsberichte verarbeitet.
Wenn Sie Performance Monitoring vollständig deaktivieren möchten, müssen Sie sowohl das Plug-in als auch die Bibliothek deaktivieren.

Performance Monitoring-Gradle-Plug-in deaktivieren

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

• Extension Property (Erweiterungseigenschaft): Das Plug-in wird zur Kompilierungszeit für eine bestimmte Build-Variante deaktiviert.

• Projekteigenschaft: Das Plug-in wird zur Kompilierzeit für alle Build-Varianten deaktiviert.

Plug-in über ein Flag für Erweiterungseigenschaften deaktivieren

Mit dem Flag Extensions Property können Sie das Performance Monitoring-Plug-in zur Kompilierungszeit für eine bestimmte Build-Variante deaktivieren.

1. Prüfen Sie in Ihrer Gradle-Datei auf Stammebene (Projektebene) (<project>/build.gradle.kts oder <project>/build.gradle), ob die Abhängigkeit des Android-Gradle-Plug-ins 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 die Build-Zeit für diese Variante wird nicht vollständig reduziert.

2. Fügen Sie das folgende Flag in die Gradle-Datei des Moduls (auf App-Ebene) ein (in der Regel <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle) und legen Sie es auf false fest, 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 Projekt-Property-Flag deaktivieren

Mit einem Projektattribut-Flag 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 legen Sie es auf false fest, 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

Wichtig :Das Flag Project Property (falls definiert) wird auf alle Build-Varianten angewendet und hat Vorrang vor dem Flag Extension Property.
Wenn Sie das Performance Monitoring-Plug-in in Ihrer Produktions-App wieder aktivieren möchten, müssen Sie entweder das Flag Project Property auskommentieren oder auf true setzen.

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.

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

Deaktivieren Sie die Bibliothek zur Kompilierzeit, lassen Sie aber nicht zu, dass Ihre App sie zur Laufzeit aktiviert.

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>

Wichtig :Diese Einstellung überschreibt die Einstellung firebase_performance_collection_enabled und muss aus der AndroidManifest.xml-Datei Ihrer App entfernt werden, um Performance Monitoring wieder zu aktivieren.

Anwendung zur Laufzeit mit Remote Config deaktivieren

Mit Firebase Remote Config können Sie das Verhalten und die Darstellung Ihrer App ändern. Das ist eine ideale Möglichkeit, um Performance Monitoring in bereitgestellten Instanzen Ihrer App zu deaktivieren.

Wenn Sie die Performance Monitoring-Datenerhebung 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 Firebase Remote Config auf Android-Geräten verwenden.

1. Achten Sie darauf, dass Remote Config im Abschnitt dependencies der Gradle-Datei Ihres Moduls (auf App-Ebene) (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.0")
   

   Java

     implementation("com.google.firebase:firebase-config:23.0.0")
   

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
           }
       }
   MainActivity.kt

   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
                   }
               }
           });
   MainActivity.java

3. Fügen Sie den folgenden Code in MainActivity.java ein, um Remote Config-Werte abzurufen und zu aktivieren:

   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
           }
       }
   MainActivity.kt

   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
                   }
               }
           });
   MainActivity.java

4. Wenn Sie Performance Monitoring in der Firebase-Konsole deaktivieren möchten, erstellen Sie in Ihrem App-Projekt den Parameter perf_disable und legen Sie seinen Wert auf true fest.

   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.