با مانیتورینگ عملکرد برای اندروید شروع کنید

قبل از اینکه شروع کنی

اگر هنوز Firebase را به پروژه اندروید خود اضافه نکرده‌اید، آن را اضافه کنید.

مرحله ۱ : 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 برای اندروید را اضافه کنید. توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌بندی کتابخانه استفاده کنید. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.5.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 استفاده خواهد کرد.

    (جایگزین) اضافه کردن وابستگی‌های کتابخانه Firebase بدون استفاده از BoM

    اگر تصمیم به استفاده از Firebase BoM ندارید، باید هر نسخه از کتابخانه Firebase را در خط وابستگی آن مشخص کنید.

    توجه داشته باشید که اگر از چندین کتابخانه Firebase در برنامه خود استفاده می‌کنید، اکیداً توصیه می‌کنیم از 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.3")
}

  2. برنامه خود را دوباره کامپایل کنید.

مرحله 2 : افزونه Performance Monitoring Gradle را به برنامه خود اضافه کنید

پس از افزودن افزونه Performance Monitoring Gradle، فایربیس به‌طور خودکار شروع به جمع‌آوری داده‌ها برای درخواست‌های شبکه 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.4" apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf") version "2.0.2" 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.4' apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf' version '2.0.2' 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. برنامه خود را دوباره کامپایل کنید.

مرحله ۳ : ایجاد رویدادهای عملکردی برای نمایش اولیه داده‌ها

فایربیس زمانی که SDK را با موفقیت به برنامه خود اضافه کنید، پردازش رویدادها را آغاز می‌کند. اگر هنوز در حال توسعه محلی هستید، با برنامه خود تعامل داشته باشید تا رویدادهایی را برای جمع‌آوری و پردازش اولیه داده‌ها ایجاد کنید.

  1. با تغییر چندین باره برنامه بین پس‌زمینه و پیش‌زمینه، تعامل با برنامه با پیمایش در صفحه‌های مختلف و/یا ایجاد درخواست‌های شبکه، رویدادها را ایجاد کنید.

  2. به داشبورد Performance کنسول Firebase بروید. باید نمایش اولیه داده‌های خود را ظرف چند دقیقه مشاهده کنید.

    اگر نمایش داده‌های اولیه خود را نمی‌بینید، نکات عیب‌یابی را مرور کنید.

مرحله ۴ : (اختیاری) مشاهده پیام‌های گزارش رویدادهای عملکردی

  1. با اضافه کردن عنصر <meta-data> به فایل AndroidManifest.xml برنامه خود، مانند زیر، ثبت اشکال‌زدایی را برای Performance Monitoring در زمان ساخت فعال کنید:

    <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. برای مشاهده داده‌های خود در کنسول Firebase، روی URL کلیک کنید. ممکن است چند لحظه طول بکشد تا داده‌ها در داشبورد به‌روزرسانی شوند.

اگر برنامه شما رویدادهای عملکرد را ثبت نمی‌کند، نکات عیب‌یابی را مرور کنید.

مرحله ۵ : (اختیاری) افزودن مانیتورینگ سفارشی برای کد خاص

برای نظارت بر داده‌های عملکرد مرتبط با کد خاص در برنامه خود، می‌توانید ردیابی‌های کد سفارشی را ابزار دقیق کنید.

با یک ردیابی کد سفارشی، می‌توانید مدت زمانی را که برنامه شما برای تکمیل یک کار خاص یا مجموعه‌ای از کارها، مانند بارگذاری مجموعه‌ای از تصاویر یا پرس و جو از پایگاه داده شما، نیاز دارد، اندازه‌گیری کنید. معیار پیش‌فرض برای ردیابی کد سفارشی، مدت زمان آن است، اما می‌توانید معیارهای سفارشی مانند بازدیدهای حافظه پنهان و هشدارهای حافظه را نیز اضافه کنید.

در کد خود، ابتدا و انتهای یک ردیابی کد سفارشی را تعریف می‌کنید (و هر معیار سفارشی دلخواه را اضافه می‌کنید) با استفاده از API ارائه شده توسط Performance Monitoring SDK. برای برنامه‌های اندروید، می‌توانید مدت زمان متدهای خاص را نیز با استفاده از حاشیه‌نویسی @AddTrace نظارت کنید.

برای کسب اطلاعات بیشتر در مورد این ویژگی‌ها و نحوه افزودن آنها به برنامه خود، به بخش افزودن نظارت برای کد خاص مراجعه کنید.

مرحله ۶ : برنامه خود را مستقر کنید و سپس نتایج را بررسی کنید

پس از اینکه Performance Monitoring با استفاده از یک یا چند دستگاه آزمایشی تأیید کردید، می‌توانید نسخه به‌روز شده برنامه خود را برای کاربرانتان مستقر کنید.

شما می‌توانید داده‌های عملکرد را در داشبورد Performance کنسول Firebase نظارت کنید.

مشکلات شناخته شده

  • افزونه‌ی Performance Monitoring Gradle نسخه‌ی ۱.۱.۰ می‌تواند باعث عدم تطابق در وابستگی‌های Guava شود و در نتیجه خطای زیر را ایجاد کند:

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

    اگر این خطا را مشاهده کردید، می‌توانید:

    • افزونه Performance Monitoring را به نسخه ۱.۱.۱ یا بالاتر ارتقا دهید (جدیدترین نسخه، نسخه ۲.۰.۲ است).

    • خط وابستگی افزونه 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 حجم کل بار مفید (payload) درخواست‌های شبکه HTTP را بر اساس مقدار تعیین‌شده در هدر content-length HTTP گزارش می‌دهد. این مقدار ممکن است همیشه دقیق نباشد.

  • Performance Monitoring فقط از فرآیند اصلی در برنامه‌های اندروید چند فرآیندی پشتیبانی می‌کند.

مراحل بعدی