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

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

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

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

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

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

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

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

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

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

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

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

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

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

כדי להתחיל ולעצור מעקב אחר קוד בהתאמה אישית, צריך לעטוף את הקוד שרוצים לעקוב אחריו בשורות קוד דומות לקוד הבא:

import { trace } from "firebase/performance";

const t = trace(perf, "CUSTOM_TRACE_NAME");
t.start();

// Code that you want to trace 
// ...

t.stop();
perf_add_custom_trace.js

const trace = perf.trace("CUSTOM_TRACE_NAME");
trace.start();

// Code that you want to trace 
// ...

trace.stop();
index.js

הוספת מעקב אחר קוד בהתאמה אישית באמצעות User Timing API

בנוסף ל-Performance Monitoring Trace API, אפשר להוסיף מעקב אחר קוד בהתאמה אישית באמצעות User Timing API של הדפדפן. משך הזמן של המעקב שנמדד באמצעות ה-API הזה מזוהה באופן אוטומטי על ידי ה-SDK של Performance Monitoring. כדאי להשתמש ב-User Timing API במיוחד אם אתם מעדיפים לטעון את ה-SDK של Performance Monitoring באופן אסינכרוני. אחרי שה-SDK יופעל, הוא יתעד את המדידות שהתרחשו לפני הטעינה שלו.

כדי להשתמש בתכונה הזו, צריך לעטוף את הקוד שרוצים לעקוב אחריו בסמנים של User Timing:

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
perf_user_timing_marks.js

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
index.js

שימו לב ש-performance בדוגמה שלמעלה מתייחס לאובייקט window.performance של הדפדפן.

כשמשתמשים ב-User Timing API, אי אפשר להוסיף מדדים ומאפיינים מותאמים אישית למעקב אחר הקוד המותאם אישית. אם רוצים להוסיף את הרכיבים המותאמים אישית האלה למעקב אחר קוד מותאם אישית, צריך להשתמש ב-Performance Monitoring Trace API.

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

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

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

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

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

import { trace } from "firebase/performance";

async function getInventory(inventoryIds) {
  const t = trace(perf, "inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  t.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  t.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  t.stop();

  return inventoryData;
}
perf_add_custom_metrics.js

async function getInventory(inventoryIds) {
  const trace = perf.trace("inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  trace.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  trace.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  trace.stop();

  return inventoryData;
}
index.js

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

משתמשים ב-Performance Monitoring Trace API כדי להוסיף מאפיינים מותאמים אישית למעקב אחר קוד מותאם אישית.

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

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

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

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

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

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

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

import { trace } from "firebase/performance";

const t = trace(perf, "test_trace");
t.putAttribute("experiment", "A");

// Update scenario
t.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = t.getAttribute("experiment");

// Delete scenario
t.removeAttribute("experiment");

// Read attributes
const traceAttributes = t.getAttributes();
perf_add_custom_attributes.js

const trace = perf.trace("test_trace");
trace.putAttribute("experiment", "A");

// Update scenario
trace.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = trace.getAttribute("experiment");

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

// Read attributes
const traceAttributes = trace.getAttributes();
index.js

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

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

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

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

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

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

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

איך משתמשים במרכז הבקרה

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

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

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

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

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

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

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

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

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

השלבים הבאים

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

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

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