הוספת מעקב מותאם אישית לקוד של אפליקציה ספציפית

iOS+ Android אינטרנט Flutter

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

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

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

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

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

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

הערה: התחלה ועצירה של מעקבים במהירות מדי יכולות להצריך משאבים רבים, לכן לכן עליכם להימנע מיצירת מעקבי קוד בהתאמה אישית בתדירות גבוהה (למשל, פעם אחת בכל פריים במשחקים).

מאפייני ברירת מחדל, מאפיינים מותאמים אישית ומדדים מותאמים אישית

במעקבים של קוד בהתאמה אישית, Performance Monitoring מתעד באופן אוטומטי מאפייני ברירת מחדל (מטא-נתונים נפוצים כמו גרסת האפליקציה, המדינה, המכשיר וכו') כדי שתוכלו לסנן את הנתונים של המעקב במסוף Firebase. שלך הם יכולים גם להוסיף מאפיינים מותאמים אישית ולעקוב אחריהם (למשל, רמת המשחק או מאפייני משתמש).

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

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

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

הוספת מעקב אחר קוד בהתאמה אישית

שימוש ב-Performance Monitoring Trace API (SWIFT | Obj-C) כדי להוסיף עקבות קוד מותאמים אישית כדי לעקוב אחר קוד של אפליקציה ספציפית.

שימו לב לנקודות הבאות:

• לאפליקציה יכולים להיות כמה מעקבים של קוד בהתאמה אישית.
• אפשר להריץ בו-זמנית כמה מעקבים של קוד בהתאמה אישית.
• השמות של מעקב הקוד בהתאמה אישית חייבים לעמוד בדרישות הבאות: אסור לכלול רווחים לבנים בתחילת השם או בסוף השם, אסור לכלול קו תחתון (_) בתחילת השם, והאורך המקסימלי הוא 100 תווים.
• במעקב אחר קוד מותאם אישית אפשר להוסיף מדדים מותאמים אישית ומאפיינים מותאמים אישית.

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

Swift

הערה: מוצר Firebase הזה לא זמין ביעדים של macOS,‏ Mac Catalyst ו-watchOS.

// Add the Performance Monitoring module to your header
import FirebasePerformance

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

// code that you want to trace

trace.stop()

Objective-C

הערה: מוצר Firebase הזה לא זמין ביעדי macOS, Mac Catalyst ו-watchOS.

// Add the Performance Monitoring module to your header
@import FirebasePerformance;

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

// code that you want to trace

[trace stop];

הוספת מדדים מותאמים אישית למעקב אחר קוד מותאם אישית

שימוש ב-Performance Monitoring Trace API (Swift | Obj-C) כדי להוסיף מדדים מותאמים אישית למעקב אחר קוד מותאם אישית.

שימו לב לנקודות הבאות:

• השמות של המדדים המותאמים אישית חייבים לעמוד בדרישות הבאות: אסור לכלול רווחים בתחילת השם או בסוף השם, אסור לכלול קו תחתון (_) בתחילת השם, והאורך המקסימלי הוא 100 תווים.
• כל מעקב אחר קוד מותאם אישית יכול לתעד עד 32 מדדים (כולל מדד ברירת המחדל משך זמן).

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

Swift

הערה: מוצר Firebase הזה לא זמין ביעדים של macOS,‏ Mac Catalyst ו-watchOS.

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.incrementMetric(named:"EVENT_NAME", by: 1)
// code that you want to trace (and log custom metrics)

trace.stop()

Objective-C

הערה: מוצר Firebase הזה לא זמין ביעדי macOS, Mac Catalyst ו-watchOS.

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace incrementMetric:@"EVENT_NAME" byInt:1];
// code that you want to trace (and log custom metrics)

[trace stop];

יצירת מאפיינים מותאמים אישית למעקבי קוד בהתאמה אישית

שימוש ב-Performance Monitoring Trace API (SWIFT | Obj-C) כדי להוסיף מאפיינים מותאמים אישית למעקבי קוד בהתאמה אישית.

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

שימו לב לנקודות הבאות:

• שמות של מאפיינים מותאמים אישית חייבים לעמוד בדרישות הבאות:

  • בלי רווחים בתחילת השורה או בסופה, בלי קו תחתון מוביל (_)
  • אין רווחים
  • האורך המקסימלי הוא 32 תווים.
  • התווים המותרים בשם הם A-Z, ‏a-z ו-_.

• כל מעקב קוד מותאם אישית יכול לתעד עד 5 מאפיינים מותאמים אישית.

• חשוב לוודא שהמאפיינים המותאמים אישית לא מכילים מידע שיכול לזהות אדם מסוים בפני Google.

  מידע נוסף על ההנחיה הזו

  איסוף נתוני משתמשים: Performance Monitoring לא אוסף בעצמו פרטים אישיים מזהים (PII), כמו שמות, כתובות אימייל או מספרי טלפון. מפתחים יכולים לאסוף נתונים נוספים באמצעות Performance Monitoring על ידי יצירת מאפיינים מותאמים אישית במעקב אחר קוד בהתאמה אישית. אסור שהנתונים האלה שנאספים דרך Performance Monitoring יכילו מידע שמאפשר ל-Google לזהות אדם מסוים.

  דוגמה להודעת יומן שלא מכילה פרטים אישיים מזהים:

  trace.putAttribute("experiment", "A");

  דוגמה למאפיין מותאם אישית שכן מכיל פרטים אישיים מזהים (אין להשתמש בסוג כזה של מאפיין מותאם אישית באפליקציה):

  trace.putAttribute("email", user.getEmailAddress());

  נתונים שחושפים פרטים אישיים מזהים כפופים מחיקה ללא הודעה מוקדמת.

Swift

הערה: מוצר Firebase הזה לא זמין ביעדים של macOS,‏ Mac Catalyst ו-watchOS.

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.setValue("A", forAttribute: "experiment")

// Update scenario.
trace.setValue("B", forAttribute: "experiment")

// Reading scenario.
let experimentValue:String? = trace.valueForAttribute("experiment")

// Delete scenario.
trace.removeAttribute("experiment")

// Read attributes.
let attributes:[String, String] = trace.attributes;

Objective-C

הערה: מוצר Firebase הזה לא זמין ביעדים של macOS,‏ Mac Catalyst ו-watchOS.

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace setValue:@"A" forAttribute:@"experiment"];

// Update scenario.
[trace setValue:@"B" forAttribute:@"experiment"];

// Reading scenario.
NSString *experimentValue = [trace valueForAttribute:@"experiment"];

// Delete scenario.
[trace removeAttribute:@"experiment"];

// Read attributes.
NSDictionary <NSString *, NSString *> *attributes = [trace attributes];

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

מעקב אחר מדדים ספציפיים בלוח הבקרה

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

מרכז הבקרה למעקב אחר ביצועים של Firebase" />

כדי להוסיף מדד ללוח המדדים:

1. נכנסים ללוח הבקרה Performance במסוף Firebase.
2. לוחצים על כרטיס מדד ריק ובוחרים מדד קיים שרוצים להוסיף ללוח.
3. לוחצים על בכרטיס מדדים מאוכלס כדי להציג אפשרויות נוספות, למשל החלפה או הסרה של מדד.

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

מידע נוסף על השימוש במרכז השליטה.

הצגת מעקבים והנתונים שלהם

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

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

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

אפשר לגשת לדף פתרון הבעיות בדרכים הבאות:

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

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

נתונים של מעקב אחר ביצועים ב-Firebase שמסוננים לפי מאפיין" />

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

מידע נוסף על הצגת נתונים של שרטוטים

השלבים הבאים

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

• מידע נוסף על מעקב אחר בעיות בביצועים במסוף Firebase

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

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