Check out what’s new from Firebase at Google I/O 2022. Learn more

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    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 .

  1. Убедитесь, что Remote Config находится в разделе dependencies файла Gradle вашего модуля (обычно это app/build.gradle ):

    implementation 'com.google.firebase:firebase-config:21.1.0'
    
  2. Настройте Remote Config и отключите мониторинг производительности, если perf_disable установлено значение true :

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

    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
                }
            }
  3. Добавьте следующий код в MainActivity.java , чтобы получить и активировать значения Remote Config:

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

    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
                }
            }
  4. Чтобы отключить мониторинг производительности в консоли Firebase, создайте параметр perf_disable в проекте вашего приложения и установите для него значение true .

    Это изменение вызовет вызовы SDK для мониторинга производительности без операций (NOOP), устраняя любое существенное влияние на производительность приложения от использования пакета SDK для мониторинга производительности в вашем приложении.

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