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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Web

import { trace } from "firebase/performance";

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

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

t.stop();

Web

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

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

trace.stop();

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

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

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

Web

const performance = window.performance;

performance.mark("measurementStart");

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

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

Web

const performance = window.performance;

performance.mark("measurementStart");

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

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

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

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

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

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

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

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

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

Web

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;
}

Web

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;
}

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

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

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

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

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

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

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

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

Web

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();

Web

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();

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

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

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

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

תמונה של לוח המדדים ב-<span class=מרכז הבקרה של מעקב הביצועים ב-Firebase" />

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

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

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

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

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

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

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

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

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

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

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

תמונה של <span class=נתונים של מעקב אחר ביצועים ב-Firebase שמסוננים לפי מאפיין" />
  • אפשר לסנן לפי כתובת URL של דף כדי להציג נתונים של דף ספציפי באתר
  • אפשר לסנן לפי סוג חיבור יעיל כדי לראות איך חיבור 3G משפיע על יישום
  • מסננים לפי מדינה כדי לוודא שמיקום מסד הנתונים לא משפיע על אזור ספציפי.

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

השלבים הבאים