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

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

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

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

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

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

אפשר לראות את הנתונים מהמעקבים האלה בכרטיסיית המשנה 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 יופעל, הוא יתעד את המדידות שבוצעו לפני הטעינה שלו.

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

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, אי אפשר להוסיף מדדים ומאפיינים מותאמים אישית למעקבים של הקוד בהתאמה אישית. אם רוצים להוסיף את הרכיבים המותאמים אישית האלה למעקב אחר קוד בהתאמה אישית, משתמשים ב-Trace API של Performance Monitoring.

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

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

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

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

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

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

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

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

מעקב אחרי מדדים ספציפיים במרכז הבקרה

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

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

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

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

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

הצגת נתוני המעקב

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

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

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

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

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

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

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

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

השלבים הבאים

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

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

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