إيقاف مراقبة أداء Firebase

أثناء تطوير التطبيق واختباره، قد تجد أنه من المفيد إيقاف مراقبة الأداء.

على سبيل المثال، من خلال إيقاف ميزة "مراقبة الأداء" أثناء عملية إنشاء التطبيق يمكنك:

• إيقاف وظائف معيّنة من "مراقبة الأداء" (مثل الوظائف التي يوفّرها المكوّن الإضافي Gradle لمراقبة الأداء) في إصدارات تصحيح الأخطاء، ولكن ينبغي إعادة تفعيل وظائف بنية الإصدار.

• إيقاف ميزة "مراقبة الأداء" عند إنشاء التطبيق مع السماح له بإعادة تفعيله في وقت التشغيل

• إيقاف ميزة "مراقبة الأداء" عند إنشاء التطبيق، وعدم السماح له إعادة تفعيلها في وقت التشغيل

يمكنك أيضًا إنشاء تطبيقك مع تفعيل ميزة "مراقبة الأداء"، ولكن استخدِم ميزة "الإعداد عن بُعد في Firebase" لمنحك مرونة في إيقاف مراقبة الأداء (وإعادة تفعيلها) في تطبيق الإنتاج مع هذا الخيار، يمكنك أيضًا ضبط تطبيقك للسماح للمستخدمين بالموافقة على المشاركة أو إيقافها باستخدام "مراقبة الأداء"

إيقاف ميزة "مراقبة الأداء" أثناء عملية إنشاء التطبيق

يمكنك إيقاف ميزة "مراقبة الأداء" أثناء عملية التصميم من خلال إيقاف مكوّن Gradle الإضافي لمراقبة الأداء و/أو من خلال إيقاف مكتبة "مراقبة الأداء" في Android

وأثناء التطوير وتصحيح الأخطاء، يكون تعطيل المكون الإضافي مفيدًا لأنك أداة القياس بواسطة المكوّن الإضافي يمكن أن تساهم في زيادة وقت الإصدار ومع ذلك، يمكنك مراعاة إبقاء تم تفعيل المكتبة بحيث يمكنك الاستمرار في عرض بيانات الأداء من تتبُّع بدء التطبيق وظهور التطبيق في المقدّمة والتشغيل في الخلفية بالإضافة إلى أي تتبُّع الرموز المخصّصة في تطبيقك.

إيقاف المكوّن الإضافي لميزة Gradle لمراقبة الأداء

يمكنك إيقاف المكوّن الإضافي "مراقبة الأداء" من خلال إضافة instrumentationEnabled باستخدام الخيارات التالية:

• موقع الإضافة: لإيقاف المكوِّن الإضافي صيغة إصدار محددة في وقت التجميع

• موقع المشروع: لإيقاف المكوِّن الإضافي جميع صيغ الإصدار في وقت التجميع

إيقاف المكوِّن الإضافي عبر علامة خاصية الإضافة

باستخدام علامة موقع الإضافات، يمكنك إيقاف المكوّن الإضافي "مراقبة الأداء". لصيغة إصدار محددة في وقت التجميع.

1. في ملف Gradle على مستوى الجذر (على مستوى المشروع) (<project>/build.gradle.kts أو <project>/build.gradle)، تأكَّد من أنّ تم تحديد اعتمادية المكوّن الإضافي لنظام Gradle المتوافق مع Android على أنّها الإصدار 3.4.0 أو إصدار أحدث.

   وبالنسبة إلى الإصدارات السابقة من مكوّن Gradle المتوافق مع Android، سيظل بإمكانك إيقاف المكوّن الإضافي "مراقبة الأداء" لمتغير إصدار معيّن، ولكن مدة الإصدار لن نلغي مساهمة هذا السعر المتغير بشكل كامل.

2. أضِف العلامة التالية إلى ملف 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>

إيقاف التطبيق في وقت التشغيل باستخدام ميزة "الإعداد عن بُعد"

تتيح لك ميزة "الإعداد عن بُعد في Firebase" إجراء تغييرات على السلوك والمظهر في تطبيقك، لذا فهو يُعد طريقة مثالية للسماح لك بإيقاف ميزة "مراقبة الأداء" في المثيلات المنشورة لتطبيقك.

لإيقاف جمع بيانات "مراقبة الأداء" في المرة القادمة التي ينتقل فيها تطبيق Android البدء، فاستخدم الرمز الموضح أدناه. لمزيد من المعلومات حول استخدام عن بُعد في تطبيق Android، راجع استخدام ميزة "الإعداد عن بُعد في Firebase" على نظام التشغيل Android

1. يُرجى التأكُّد من أنّ ميزة "الإعداد عن بُعد" متوفّرة في القسم dependencies من الوحدة (على مستوى التطبيق) ملف Gradle (عادةً <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle):

   Kotlin+KTX

     implementation("com.google.firebase:firebase-config-ktx:22.0.0")
   

   Java

     implementation("com.google.firebase:firebase-config:22.0.0")
   

2. إعداد "الإعداد عن بُعد" وإيقاف "مراقبة الأداء" إذا كان 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

3. أضِف الرمز التالي إلى MainActivity.java لاسترجاعه وتفعيله. قيم "الإعداد عن بُعد":

   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

4. لإيقاف "مراقبة الأداء" في وحدة تحكُّم Firebase، أنشئ perf_disable. في مشروع تطبيقك، ثم اضبط قيمتها على true.

   سيؤدي هذا التغيير إلى "عدم التشغيل" لحزمة تطوير البرامج (SDK) لمراقبة الأداء مكالمتان NOOP)، والقضاء على أي تأثيرات كبيرة في أداء التطبيق من استخدام حزمة SDK لمراقبة الأداء في تطبيقك.

   في حال ضبط قيمة perf_disable على false، ستظل "مراقبة الأداء" مفعّلة.