תחילת השימוש ב-Performance Monitoring ל-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:33.5.1"))
   
       // 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, האפליקציה תמיד תשתמש בגרסאות תואמות של ספריות Android של 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:21.0.2")
   }

   מחפשים מודול ספרייה ספציפי ל-Kotlin? החל מאוקטובר 2023 (32.5.0Firebase BoM), מפתחי Kotlin ו-Java יכולים להסתמך על מודול הספרייה הראשי (למידע נוסף, ראו שאלות נפוצות על היוזמה הזו).

2. מקמפלים מחדש את האפליקציה.

שלב 2: הוספה של הפלאגין Performance Monitoring Gradle לאפליקציה

אחרי שמוסיפים את הפלאגין Performance Monitoring Gradle, מערכת Firebase מתחילה לאסוף באופן אוטומטי נתונים עבור בקשות רשת HTTP/S. הפלאגין מאפשר גם ליצור מעקבי קוד בהתאמה אישית באמצעות הערה מסוג@AddTrace.

איך פועל הפלאגין Performance Monitoring

לפני שהקוד מומר לקובצי DEX, הפלאגין Performance Monitoring משתמש ב-Transform API ובמסגרת האינסטרומנטציה של ASM bytecode כדי להיכנס לקובצי הכיתות שעברו הידור של האפליקציה וכדי להגדיר את הקוד (כדי למדוד ביצועים). הזמן שלוקח להשתמש בקוד תלוי בעיקר במספר הכיתות ובגודל שלהן.

אם נדרש יותר זמן לבצע הידור לאפליקציה, כדאי לשקול את האפשרויות הבאות:

• משביתים את הפלאגין Performance Monitoring בגרסאות ה-debug build בזמן הידור
• מודולרים את הקוד כדי לבצע אופטימיזציה של מהירות ה-build

1. לroot-level (project-level) של 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.2" apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id("com.google.firebase.firebase-perf") version "1.4.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.2' apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id 'com.google.firebase.firebase-perf' version '1.4.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. הידור מחדש של האפליקציה.

שלב 3: יצירת אירועי ביצועים להצגת הנתונים הראשונית

Firebase מתחיל לעבד את האירועים אחרי שמוסיפים את ה-SDK לאפליקציה. אם אתם עדיין מפתחים באופן מקומי, עליכם לבצע פעולות באפליקציה כדי ליצור אירועים לצורך איסוף ועיבוד ראשוני של נתונים.

1. יצירת אירועים על ידי העברת האפליקציה בין הרקע לחזית מספר פעמים, אינטראקציה עם האפליקציה על ידי ניווט בין מסכים שונים ו/או הפעלת בקשות רשת.

2. עוברים אל מרכז הבקרה לביצועים במסוף Firebase. הנתונים הראשוניים אמורים להופיע תוך כמה דקות.

   אם הנתונים הראשוניים לא מוצגים, כדאי לעיין בטיפים לפתרון בעיות.

שלב 4: (אופציונלי) הצגת הודעות ביומן לגבי אירועי ביצועים

1. כדי להפעיל רישום ביומן של ניפוי באגים ל-Performance Monitoring בזמן ה-build, מוסיפים רכיב <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: (אופציונלי) הוספה של מעקב מותאם אישית לקוד ספציפי

כדי לעקוב אחרי נתוני הביצועים שמשויכים לקוד ספציפי באפליקציה, אפשר להשתמש במעקב אחר קוד בהתאמה אישית.

בעזרת מעקב אחר קוד בהתאמה אישית תוכלו למדוד כמה זמן לוקח לאפליקציה להשלים משימה מסוימת או קבוצת משימות מסוימת, כמו טעינת קבוצת תמונות או שליחת שאילתות למסד הנתונים. מדד ברירת המחדל של מעקב אחר קוד בהתאמה אישית הוא משך הזמן שלו, אבל אפשר גם להוסיף מדדים מותאמים אישית, כמו היטים במטמון ואזהרות לגבי זיכרון.

בקוד, מגדירים את ההתחלה והסיום של מעקב קוד בהתאמה אישית (ומוסיפים את המדדים בהתאמה אישית הרצויים) באמצעות ה-API שסופק על ידי ה-SDK של Performance Monitoring. באפליקציות ל-Android, אפשר גם לעקוב אחרי משך הזמן של שיטות ספציפיות באמצעות הערה ‎@AddTrace.

במאמר הוספת מעקב אחרי קוד ספציפי תוכלו לקרוא מידע נוסף על התכונות האלה ולראות איך מוסיפים אותן לאפליקציה.

שלב 6: פורסים את האפליקציה ובודקים את התוצאות

אחרי האימות של Performance Monitoring באמצעות מכשיר בדיקה אחד או יותר, אפשר לפרוס למשתמשים את הגרסה המעודכנת של האפליקציה.

אפשר לעקוב אחרי נתוני הביצועים במרכז הבקרה לביצועים שבמסוף Firebase.

בעיות מוכרות

• הפלאגין Performance Monitoring Gradle גרסה 1.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.2).

  • מחליפים את שורת התלות של הפלאגין 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, על סמך הערך שהוגדר בכותרת של אורך התוכן ב-HTTP. יכול להיות שהערך הזה לא יהיה מדויק תמיד.

• Performance Monitoring תומך רק בתהליך הראשי באפליקציות ל-Android עם ריבוי תהליכים.

השלבים הבאים

• בודקים ומריצים את דוגמת הקוד Performance Monitoring של Android ב-GitHub.

• מידע נוסף על נתונים שנאספים באופן אוטומטי על ידי Performance Monitoring:

  • נתונים שקשורים למחזור החיים של האפליקציה, כמו שעת ההתחלה של האפליקציה
  • נתוני רינדור המסך באפליקציה
  • נתונים של בקשות רשת מסוג HTTP/S שהאפליקציה שלכם שלחה

• הצגה, מעקב וסינון של נתוני הביצועים במסוף Firebase.

• כדי להוסיף מעקב אחרי משימות או תהליכי עבודה ספציפיים באפליקציה, תוכלו להטמיע כלי למעקב אחרי קוד מותאם אישית.

• שימוש במאפיינים לסינון נתוני הביצועים