با Performance Monitoring برای Android شروع کنید

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

اگر قبلاً این کار را نکرده‌اید، Firebase را به پروژه Android خود اضافه کنید .

مرحله 1 : SDK نظارت بر عملکرد را به برنامه خود اضافه کنید

پس از اینکه SDK نظارت بر عملکرد را اضافه کردید، Firebase به طور خودکار شروع به جمع‌آوری داده‌ها برای رندر صفحه برنامه و داده‌های مربوط به چرخه عمر برنامه شما می‌کند (مانند زمان شروع برنامه ). برای فعال کردن Firebase برای نظارت بر درخواست‌های شبکه، باید افزونه Performance Monitoring Gradle را نیز اضافه کنید (مرحله بعد).

  1. با استفاده از Firebase Android BoM ، وابستگی را برای کتابخانه Android Monitoring عملکرد در فایل Gradle ماژول (سطح برنامه) خود (معمولا app/build.gradle ) اعلام کنید.

    جاوا

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.4')
    
        // Declare 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 برای مدیریت نسخه های کتابخانه استفاده کنید، که تضمین می کند همه نسخه ها سازگار هستند.

    dependencies {
        // Declare 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:20.0.4'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.4')
    
        // Declare 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-ktx'
    }
    

    با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخه‌های سازگار کتابخانه‌های Firebase Android استفاده می‌کند.

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

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

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

    dependencies {
        // Declare 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-ktx:20.0.4'
    }
    

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

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

پس از افزودن افزونه Performance Monitoring Gradle، Firebase به طور خودکار شروع به جمع‌آوری داده‌ها برای درخواست‌های شبکه HTTP/S می‌کند . این افزونه همچنین به شما امکان می‌دهد تا با استفاده از حاشیه‌نویسی @AddTrace ، ردیابی کد سفارشی را تنظیم کنید.

  1. در فایل Gradle ماژول (سطح برنامه) خود (معمولا app/build.gradle )، افزونه Performance Monitoring را اعمال کنید:

    apply plugin: 'com.android.application'
    apply plugin: 'com.google.gms.google-services'
    // Apply the Performance Monitoring plugin
    apply plugin: 'com.google.firebase.firebase-perf'
    
    android {
      // ...
    }
    
  2. در فایل Gradle در سطح ریشه (سطح پروژه) خود ( build.gradle )، قوانینی را اضافه کنید تا افزونه نظارت بر عملکرد را نیز شامل شود.

    buildscript {
    
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // Add the Bintray repository
          jcenter()
        }
    
        dependencies {
          // ...
    
          // To benefit from the latest Performance Monitoring plugin features,
          // update your Android Gradle Plugin dependency to at least v3.4.0
          classpath 'com.android.tools.build:gradle:3.4.0'
    
          classpath 'com.google.gms:google-services:4.3.10'  // Google Services plugin
    
          // Add the dependency for the Performance Monitoring plugin
          classpath 'com.google.firebase:perf-plugin:1.4.1'  // Performance Monitoring plugin
        }
    }
    
  3. برنامه خود را دوباره کامپایل کنید

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

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

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

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

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

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

  1. با افزودن یک عنصر <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. انواع گزارش‌های زیر را بررسی کنید که نشان می‌دهد نظارت بر عملکرد، رویدادهای عملکرد را ثبت می‌کند:

    • Logging trace metric: TRACE_NAME , FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL
  5. برای مشاهده داده های خود در کنسول Firebase روی URL کلیک کنید. ممکن است چند لحظه طول بکشد تا داده ها در داشبورد به روز شوند.

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

مرحله 5 : (اختیاری) نظارت سفارشی را برای کد خاص اضافه کنید

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

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

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

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

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

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

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

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

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

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

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

    • افزونه Performance Monitoring را به نسخه 1.1.1 یا جدیدتر ارتقا دهید (جدیدترین افزونه نسخه 1.4.1 است).

    • خط وابستگی افزونه نظارت بر عملکرد را در فایل Gradle سطح ریشه (سطح پروژه) خود ( build.gradle ) به صورت زیر جایگزین کنید:

      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'
          }
        }
      }
      
  • نظارت بر عملکرد، اندازه کل حجم بار برای درخواست های شبکه HTTP را بر اساس مقدار تنظیم شده در سربرگ طول محتوای HTTP گزارش می کند. این مقدار ممکن است همیشه دقیق نباشد.

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

مراحل بعدی