Отключить мониторинг производительности Firebase

Во время разработки и тестирования приложений может оказаться полезным отключить мониторинг производительности.

Например, отключив мониторинг производительности во время сборки приложения , вы сможете:

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

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

Отключите мониторинг производительности во время процесса сборки приложения.

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

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

Примечание. Если вы отключите библиотеку, но оставите плагин включенным, инструментирование плагином все равно произойдет. Однако любые собранные данные, связанные с плагином (то есть обработка аннотаций @AddTrace и автоматический мониторинг сетевых запросов HTTP/S ), не обрабатываются для составления отчетов о производительности.
Чтобы полностью отключить мониторинг производительности, вам необходимо отключить как плагин, так и библиотеку.

Отключите плагин Gradle для мониторинга производительности

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

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

Отключите плагин с помощью флага свойства расширения.

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

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

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

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

Отключите плагин с помощью флага свойства проекта.

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

Добавьте следующий флаг в файл gradle.properties , затем установите для него значение false , чтобы отключить плагин мониторинга производительности.

// ...

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

Отключите библиотеку Android для мониторинга производительности.

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

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

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

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

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

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

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

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

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

Чтобы отключить сбор данных мониторинга производительности при следующем запуске приложения Android, используйте пример кода, показанный ниже. Дополнительную информацию об использовании Remote Config в приложении Android см. в разделе Использование Firebase Remote Config на Android .

Убедитесь, что Remote Config находится в разделе dependencies файла Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ):
Kotlin+KTX
```
  implementation("com.google.firebase:firebase-config-ktx:21.6.3")
```
Java
```
  implementation("com.google.firebase:firebase-config:21.6.3")
```

Настройте Remote Config и отключите мониторинг производительности, если для perf_disable установлено значение true :

Kotlin+KTX

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

Добавьте следующий код в MainActivity.java , чтобы получить и активировать значения Remote Config:

Kotlin+KTX

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

Чтобы отключить мониторинг производительности в консоли Firebase, создайте параметр perf_disable в проекте вашего приложения, а затем установите для него значение true .
Это изменение приведет к вызову «бездействия» (NOOP) пакета Performance Monitoring SDK, что исключит любое существенное влияние на производительность приложения при использовании Performance Monitoring SDK в вашем приложении.
Если вы установите для параметра perf_disable значение false , мониторинг производительности останется включенным.