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


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

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

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

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

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

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

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

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

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

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

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

שימוש בPerformance Monitoring Trace 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 יופעל, הוא יתעד את המדידות שהתרחשו לפני הטעינה שלו.

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

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

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

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

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

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

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

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

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

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

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

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

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

השלבים הבאים

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

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

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