Как отключить Firebase Performance Monitoring

При разработке и тестировании приложения может быть полезно отключить Performance Monitoring.

Например, если вы отключите Performance Monitoring во время сборки приложения, то сможете:

• Отключите некоторые функции Performance Monitoring (например, предоставляемые плагином Gradle для Performance Monitoring) в отладочных сборках, но оставьте их включенными в конечной сборке.

• Отключите Performance Monitoring при создании приложения, но разрешите приложению повторно включить его во время выполнения.

• Отключите Performance Monitoring при создании приложения и не разрешайте приложению повторно включать его во время выполнения.

Вы также можете создать приложение с включенным Performance Monitoring, но использовать Firebase Remote Config, чтобы иметь возможность отключать (и снова включать) Performance Monitoring в рабочей версии приложения. При этом вы даже можете настроить приложение так, чтобы пользователи могли сами включать и отключать Performance Monitoring.

Отключите Performance Monitoring во время сборки приложения

Вы можете отключить Performance Monitoring во время сборки, отключив плагин Gradle для Performance Monitoring и/или отключив библиотеку Android для Performance Monitoring.

Отключение плагина во время разработки и отладки может быть полезно, поскольку инструментирование плагина может увеличить время сборки. Однако вы можете оставить библиотеку включенной, чтобы по-прежнему просматривать данные об эффективности из трассировок запуска приложения, а также его работы в активном и фоновом режимах и любых трассировок пользовательского кода в приложении.

Как отключить плагин Performance Monitoring для Gradle

Вы можете отключить плагин Performance Monitoring, добавив флаг instrumentationEnabled с помощью следующих параметров:

• Свойство расширения – отключает плагин для определенного варианта сборки во время компиляции.

• Свойство проекта – отключает плагин для всех вариантов сборки во время компиляции.

Отключите плагин с помощью флага Extension Property

С помощью флага Extensions Property можно отключить плагин Performance Monitoring для определенного варианта сборки во время компиляции.

1. В файле Gradle корневого уровня (на уровне проекта) (<project>/build.gradle.kts или <project>/build.gradle) убедитесь, что зависимость плагина Android Gradle указана как v3.4.0 или более поздняя версия.

   В более ранних версиях плагина Android Gradle вы можете отключить плагин Performance Monitoring для определенного варианта сборки, но время сборки для этого варианта не будет полностью исключено.

2. Добавьте в файл Gradle модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle) следующий флаг и задайте для него значение false, чтобы отключить плагин 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
         }
       }
     }
   }

Отключение плагина с помощью флага Project Property

С помощью флага Project Property можно отключить плагин Performance Monitoring для всех вариантов сборки во время компиляции.

Добавьте в файл gradle.properties следующий флаг и задайте для него значение false, чтобы отключить плагин 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

Как отключить библиотеку Performance Monitoring для Android

Если вы отключите библиотеку Performance Monitoring во время компиляции, то сможете разрешить или запретить ее включение во время выполнения.

Отключите библиотеку во время компиляции, но разрешите приложению включать ее во время выполнения

Добавьте в файл AndroidManifest.xml приложения следующий элемент <meta-data>:

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

Отключить библиотеку во время компиляции и запретить приложению включать ее во время выполнения

Добавьте в файл AndroidManifest.xml приложения следующий элемент <meta-data>:

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

Отключите приложение во время выполнения с помощью Remote Config

Firebase Remote Config позволяет менять поведение и внешний вид приложения, поэтому с его помощью можно отключить Performance Monitoring в развернутых экземплярах приложения.

Чтобы отключить сбор данных Performance Monitoring при следующем запуске приложения Android, используйте приведенный ниже пример кода. Подробнее о том, как использовать Remote Config в приложении для Android, читайте в статье Как использовать Firebase Remote Config на устройствах Android.

1. Убедитесь, что Remote Config находится в разделе dependencies файла Gradle модуля (на уровне приложения), который обычно называется <project>/<app-module>/build.gradle.kts или <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. Настройте Remote Config и отключите Performance Monitoring, если для perf_disable задано значение 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
           }
       }
   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. Добавьте в файл MainActivity.java следующий код, чтобы получить и активировать значения 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
           }
       }
   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. Чтобы отключить Performance Monitoring в консоли Firebase, создайте параметр perf_disable в проекте приложения и задайте для него значение true.

   После этого вызовы SDK Performance Monitoring станут вызовами без операции (NOOP), что устранит любое значительное влияние SDK Performance Monitoring на производительность приложения.

   Если задать для параметра perf_disable значение false, то Performance Monitoring останется включенным.