بدء استخدام ميزة "مراقبة الأداء" على Android

قبل البدء

أضِف Firebase إلى مشروع Android إذا لم يسبق لك إجراء ذلك.

الخطوة 1: إضافة حزمة تطوير البرامج (SDK) الخاصة بـ Performance Monitoring إلى تطبيقك

بعد إضافة حزمة تطوير البرامج (SDK) الخاصة بـ Performance Monitoring، يبدأ Firebase تلقائيًا في جمع البيانات الخاصة بعرض الشاشة في تطبيقك والبيانات ذات الصلة بدورة حياة تطبيقك (مثل وقت بدء تشغيل التطبيق). لكي تتمكّن Firebase من تتبُّع طلبات الشبكة، عليك أيضًا إضافة Performance Monitoring مكوّن Gradle الإضافي (الخطوة التالية).

  1. في ملف Gradle للوحدة (على مستوى التطبيق) (عادةً <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle)، أضِف الاعتمادية لمكتبة Performance Monitoring لنظام التشغيل Android. ننصحك باستخدام Firebase Android BoM للتحكّم في إصدارات المكتبة. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

    // Add the dependency for the Performance Monitoring library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-perf")
}

    باستخدام Firebase Android BoM، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Firebase Android.

    (بديل)  أضِف تبعيات مكتبة Firebase بدون استخدام BoM

    إذا اخترت عدم استخدام Firebase BoM، عليك تحديد إصدار كل مكتبة من مكتبات Firebase في سطر التبعية الخاص بها.

    يُرجى العِلم أنّه في حال استخدام مكتبات Firebase BoMمتعدّدة في تطبيقك، ننصحك بشدة باستخدام BoM لإدارة إصدارات المكتبات، ما يضمن توافق جميع الإصدارات. 

    dependencies {
    // Add the dependency for the Performance Monitoring library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-perf:22.0.0")
}

  2. أعِد تجميع تطبيقك.

الخطوة 2: إضافة Performance Monitoring Gradle plugin إلى تطبيقك

بعد إضافة Performance Monitoring مكوّن Gradle الإضافي، يبدأ Firebase تلقائيًا في جمع البيانات الخاصة بطلبات الشبكة HTTP/S. تتيح لك الإضافة أيضًا تسجيل عمليات تتبُّع الرموز المخصّصة باستخدام التعليق التوضيحي ‎@AddTrace.

  1. في ملف Gradle على مستوى الجذر (على مستوى المشروع) (<project>/build.gradle.kts أو <project>/build.gradle)، أضِف Performance Monitoring المكوّن الإضافي لنظام Gradle:

    Kotlin 

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id("com.android.application") version "7.3.0" apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id("com.google.gms.google-services") version "4.4.3" apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf") version "2.0.0" apply false
}

    Groovy 

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id 'com.android.application' version '7.3.0' apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id 'com.google.gms.google-services' version '4.4.3' apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf' version '2.0.0' apply false
}

  2. في ملف Gradle الخاص بالوحدة (على مستوى التطبيق) (عادةً <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle)، أضِف المكوّن الإضافي Performance Monitoring لنظام Gradle:

    Kotlin 

    plugins {
    id("com.android.application")

    // Make sure that you have the Google services Gradle plugin
    id("com.google.gms.google-services")

    // Add the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf")
    ...
}

    Groovy 

    plugins {
    id 'com.android.application'

    // Make sure that you have the Google services Gradle plugin
    id 'com.google.gms.google-services'

    // Add the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf'
    ...
}

  3. أعِد تجميع تطبيقك.

الخطوة 3: إنشاء أحداث الأداء لعرض البيانات الأوّلية

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

  1. يمكنك إنشاء أحداث من خلال التبديل بين تشغيل تطبيقك في الخلفية وفي المقدّمة عدة مرات، والتفاعل مع تطبيقك من خلال التنقّل بين الشاشات، و/أو تشغيل طلبات الشبكة.

  2. انتقِل إلى لوحة بيانات الأداء في وحدة تحكّم Firebase. من المفترض أن تظهر لك البيانات الأولية في غضون بضع دقائق.

    إذا لم تظهر لك بياناتك الأولية، راجِع نصائح تحديد المشاكل وحلّها.

الخطوة 4: (اختياري) عرض رسائل السجلّ لأحداث الأداء

  1. فعِّل تسجيل تصحيح الأخطاء في Performance Monitoring في وقت الإنشاء من خلال إضافة عنصر <meta-data> إلى ملف AndroidManifest.xml في تطبيقك، كما يلي:

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

  2. راجِع رسائل السجلّ بحثًا عن أي رسائل خطأ.

  3. تضع Performance Monitoring علامات على رسائل السجلّ باستخدام FirebasePerformance. باستخدام فلترة logcat، يمكنك الاطّلاع على تتبُّع المدة وتسجيل طلبات شبكة HTTP/S على وجه التحديد من خلال تنفيذ الأمر التالي:

    adb logcat -s FirebasePerformance

  4. ابحث عن أنواع السجلّات التالية التي تشير إلى أنّ Performance Monitoring تسجّل أحداث الأداء:

    • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL

  5. انقر على عنوان URL لعرض بياناتك في وحدة تحكّم Firebase. قد يستغرق تعديل البيانات في لوحة البيانات بضع لحظات.

إذا كان تطبيقك لا يسجّل أحداث الأداء، راجِع نصائح تحديد المشاكل وحلّها.

الخطوة 5: (اختيارية) إضافة ميزة مراقبة مخصّصة لرمز معيّن

لمراقبة بيانات الأداء المرتبطة برمز معيّن في تطبيقك، يمكنك تسجيل عمليات تتبُّع الرموز المخصّصة.

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

في الرمز البرمجي، يمكنك تحديد بداية ونهاية عملية تتبُّع رمز برمجي مخصّص (وإضافة أي مقاييس مخصّصة مرغوبة) باستخدام واجهة برمجة التطبيقات التي توفّرها حزمة تطوير البرامج (SDK) Performance Monitoring. بالنسبة إلى تطبيقات Android، يمكنك أيضًا تتبُّع مدة تنفيذ طرق معيّنة باستخدام التعليق التوضيحي@AddTrace.

انتقِل إلى إضافة مراقبة لرمز معيّن للاطّلاع على مزيد من المعلومات حول هذه الميزات وكيفية إضافتها إلى تطبيقك.

الخطوة 6: نشر تطبيقك ثم مراجعة النتائج

بعد التحقّق من صحة Performance Monitoring باستخدام جهاز اختباري واحد أو أكثر، يمكنك طرح الإصدار المعدَّل من تطبيقك للمستخدمين.

يمكنك مراقبة بيانات الأداء في لوحة بيانات الأداء في وحدة تحكّم Firebase.

المشكلات المعروفة

  • يمكن أن يتسبّب الإصدار 1.1.0 من المكوّن الإضافي Performance Monitoring لنظام Gradle في حدوث عدم تطابق في تبعيات Guava، ما يؤدي إلى ظهور الخطأ التالي:

    Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
> com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;

    إذا ظهر لك هذا الخطأ، يمكنك اتّباع إحدى الخطوتَين التاليتَين:

    • يجب ترقية المكوّن الإضافي Performance Monitoring إلى الإصدار 1.1.1 أو إصدار أحدث (أحدث إصدار هو 2.0.0).

    • استبدِل سطر الاعتمادية الخاص بالمكوّن الإضافي Performance Monitoring في ملف Gradle على مستوى الجذر (على مستوى المشروع) (<project>/build.gradle.kts أو <project>/build.gradle) على النحو التالي:

      Kotlin 

      buildscript {
  // ...

  dependencies {
    // ...

    // Replace the standard Performance Monitoring plugin dependency line, as follows:
    classpath("com.google.firebase:perf-plugin:1.1.0") {
        exclude(group = "com.google.guava", module = "guava-jdk5")
    }
  }
}

      Groovy 

      buildscript {
  // ...

  dependencies {
    // ...

    // Replace the standard Performance Monitoring plugin dependency line, as follows:
    classpath('com.google.firebase:perf-plugin:1.1.0') {
        exclude group: 'com.google.guava', module: 'guava-jdk5'
    }
  }
}

  • تعرض السمة Performance Monitoring إجمالي حجم الحمولة لطلبات شبكة HTTP استنادًا إلى القيمة المحدّدة في عنوان HTTP content-length. قد لا تكون هذه القيمة دقيقة دائمًا.

  • لا تتوافق Performance Monitoring إلا مع العملية الرئيسية في تطبيقات Android المتعددة العمليات.

الخطوات التالية