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


Во время разработки и тестирования приложения может оказаться полезным отключить 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 во время процесса сборки , отключив плагин Performance Monitoring Gradle и/или отключив библиотеку Performance Monitoring Android .

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

Отключить плагин Gradle Performance Monitoring

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

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

Используя флаг свойства расширений , вы можете отключить плагин 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
          }
        }
      }
    }

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

Используя флаг свойств проекта , вы можете отключить плагин 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 во время компиляции, вы сможете выбрать, разрешить ли вашему приложению включать библиотеку во время выполнения.

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

Добавьте следующий элемент <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 позволяет вам вносить изменения в поведение и внешний вид вашего приложения, поэтому это идеальный способ отключить 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:22.1.2")
    

    Java

      implementation("com.google.firebase:firebase-config:22.1.2")
    
  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
            }
        }

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

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

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

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