Firebase Performance Monitoring deaktivieren

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

Wenn Sie beispielsweise Performance Monitoring während des App-Build-Prozesses deaktivieren, haben Sie folgende Möglichkeiten:

Deaktivieren Sie bestimmte Funktionen von Performance Monitoring (z. B. die vom Performance Monitoring Gradle-Plug-in bereitgestellten) in Ihren Debug-Builds, aktivieren Sie sie aber wieder für Ihren Release-Build.
Deaktivieren Sie Performance Monitoring beim Erstellen Ihrer App, erlauben Sie aber Ihrer App, sie zur Laufzeit wieder zu aktivieren.
Deaktivieren Sie Performance Monitoring beim Erstellen Ihrer App und erlauben Sie nicht, dass sie in der Laufzeit wieder aktiviert wird.

Sie können Ihre App auch mit Performance Monitoring aktiviert erstellen, aber Firebase Remote Config verwenden, um Performance Monitoring in Ihrer Produktions-App flexibel zu deaktivieren (und wieder zu aktivieren). Mit dieser Option können Sie Ihre App sogar so konfigurieren, dass Nutzer 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 und/oder die Performance Monitoring Android-Bibliothek deaktivieren.

Während der Entwicklung und Fehlerbehebung ist es nützlich, das Plug-in zu deaktivieren, da die Instrumentierung durch das Plug-in zu einer längeren Buildzeit beitragen kann. Sie können die Bibliothek jedoch aktiviert lassen, damit Sie weiterhin Leistungsdaten aus Traces zum App-Start, zur App im Vordergrund und zur App im Hintergrund sowie alle Traces mit benutzerdefiniertem Code in Ihrer App sehen können.

Performance Monitoring-Gradle-Plug-in deaktivieren

Sie können das Performance Monitoring-Plug-in deaktivieren, indem Sie ein instrumentationEnabled-Flag hinzufügen. Verwenden Sie dazu eine der folgenden Optionen:

Erweiterungseigenschaft: Deaktiviert das Plug-in zur spezifischen Buildvariante zur Kompilierungszeit.
Projekteigenschaft: Deaktiviert das Plug-in zur Kompilierungszeit für alle Buildvarianten.

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

Mit einem Flag für Extensions-Properties können Sie das Performance Monitoring-Plug-in bei der Kompilierung für eine bestimmte Buildvariante deaktivieren.

Achten Sie darauf, dass in der Gradle-Datei auf Stammebene (Projektebene) (<project>/build.gradle.kts oder <project>/build.gradle) die Abhängigkeit vom Android Gradle-Plug-in als Version 3.4.0 oder höher angegeben ist.

Bei älteren Versionen des Android Gradle-Plug-ins können Sie das Performance Monitoring-Plug-in für eine bestimmte Buildvariante weiterhin deaktivieren. Der Beitrag zur Buildzeit für diese Variante wird jedoch nicht vollständig eliminiert.

Fügen Sie der Gradle-Datei des Moduls (auf App-Ebene) (in der Regel <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle) das folgende Flag hinzu und setzen Sie es dann 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 Projekteigenschaften deaktivieren

Mit einem Flag für Projekteigenschaften können Sie das Performance Monitoring-Plug-in bei der Kompilierung für alle Buildvarianten 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

Performance Monitoring-Android-Bibliothek deaktivieren

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

Bibliothek zur Kompilierungszeit 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>

Die Bibliothek zur Kompilierungszeit deaktivieren, aber nicht zulassen, 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>

Anwendung mit Remote Config zur Laufzeit deaktivieren

Mit Firebase Remote Config können Sie das Verhalten und die Darstellung Ihrer App ändern. So können Sie Performance Monitoring in bereitgestellten Instanzen Ihrer App deaktivieren.

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

Achten Sie darauf, dass sich Remote Config im Abschnitt dependencies der Gradle-Datei Ihres Moduls (auf App-Ebene) befindet (in der Regel <project>/<app-module>/build.gradle.kts oder <project>/<app-module>/build.gradle):
Kotlin
```
  implementation("com.google.firebase:firebase-config-ktx:22.0.1")
```
Java
```
  implementation("com.google.firebase:firebase-config:22.0.1")
```

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

Fügen Sie MainActivity.java den folgenden Code hinzu, 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

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

Durch diese Änderung werden Aufrufe an das Performance Monitoring SDK mit „No Operation“ (NOOP) ausgeführt. Dadurch werden alle erheblichen Auswirkungen auf die App-Leistung durch die Verwendung des Performance Monitoring SDK in Ihrer App vermieden.

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