إيقاف مراقبة أداء 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" أثناء عملية التصميم من خلال إيقاف مكوّن Gradle الإضافي Performance Monitoring و/أو من خلال إيقاف مكتبة Android في Performance Monitoring

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

إيقاف مكوّن Gradle الإضافي "Performance Monitoring"

يمكنك إيقاف المكوّن الإضافي Performance Monitoring من خلال إضافة instrumentationEnabled. باستخدام الخيارات التالية:

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

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

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

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

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

    وبالنسبة إلى الإصدارات السابقة من مكوّن Gradle المتوافق مع Android، سيظل بإمكانك إيقاف المكوّن الإضافي 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

إيقاف مكتبة Android في Performance Monitoring

في حال إيقاف مكتبة 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+KTX

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

    Java

      implementation("com.google.firebase:firebase-config:22.0.0")
    
  2. اضبط Remote Config وأوقِف Performance Monitoring إذا كان 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
            }
        }

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

    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.

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

    في حال ضبط قيمة perf_disable على false، ستظل القيمة Performance Monitoring. مفعّلة.