إضافة تتبُّع مخصّص لرمز تطبيق معيّن

تجمع ميزة "مراقبة الأداء" تتبُّعات لمساعدتك في تتبُّع أداء تطبيقك. التتبُّع هو تقرير عن بيانات الأداء التي يتم تسجيلها بين نقطتَين في تطبيقك.

يمكنك إنشاء بيانات تتبُّع خاصة بك لمراقبة بيانات الأداء المرتبطة برمز محدّد في تطبيقك. باستخدام تتبُّع الرموز المخصّص، يمكنك قياس المدة التي يستغرقها تطبيقك لإكمال مهمة محدّدة أو مجموعة من المهام، على سبيل المثال، تحميل مجموعة من الصور أو إجراء طلب بحث في قاعدة البيانات.

يكون المقياس التلقائي لتتبُّع الرموز المخصّصة هو "المدة" (الوقت بين نقطتي البداية والإيقاف الخاصة بتتبُّع التتبُّع)، ولكن يمكنك إضافة مقاييس مخصَّصة أيضًا.

في الرمز البرمجي، يمكنك تحديد بداية ونهاية عملية تتبُّع الرمز المخصّص باستخدام واجهات برمجة التطبيقات التي توفّرها حزمة "SDK لمراقبة الأداء". يمكن بدء عمليات تتبُّع الرموز المخصّصة في أي وقت بعد إنشائها، وتُعد هذه العمليات آمنة في سلاسل المحادثات.

بما أن المقياس التلقائي الذي يتم جمعه لعمليات التتبّع هذه هو "المدة"، يُطلق عليها أحيانًا "تتبُّع المدة".

يمكنك عرض البيانات من عمليات التتبّع هذه في علامة التبويب الفرعية تتبُّعات الاستخدام المخصّصة في جدول بيانات التتبُّع، في أسفل لوحة بيانات الأداء (تعرَّف على مزيد من المعلومات عن استخدام وحدة التحكّم لاحقًا في هذه الصفحة).

السمات التلقائية والسمات المخصّصة والمقاييس المخصّصة

بالنسبة إلى عمليات تتبُّع الرموز المخصّصة، تسجِّل "مراقبة الأداء" تلقائيًا السمات التلقائية (البيانات الوصفية الشائعة، مثل البلد أو المتصفّح أو عنوان URL للصفحة وما إلى ذلك) حتى تتمكّن من فلترة بيانات عملية التتبُّع في وحدة تحكُّم Firebase. ويمكنك أيضًا إضافة سمات مخصّصة ومراقبتها (مثل مستوى اللعبة أو خصائص المستخدمين).

يمكنك أيضًا ضبط عملية تتبُّع رموز مخصّصة لتسجيل المقاييس المخصّصة للأحداث ذات الصلة بالأداء التي تقع في نطاق عملية التتبُّع. على سبيل المثال، يمكنك إنشاء مقياس مخصّص لعدد نتائج ذاكرة التخزين المؤقت والأخطاء المفقودة أو عدد المرات التي تصبح فيها واجهة المستخدم غير مستجيبة لفترة زمنية ملحوظة.

يتم عرض السمات المخصّصة والمقاييس المخصَّصة في وحدة تحكُّم Firebase إلى جانب السمات التلقائية والمقياس التلقائي للتتبُّع.

إضافة عمليات تتبُّع رموز مخصّصة

استخدِم 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، يمكنك إضافة عمليات تتبُّع الرموز المخصّصة باستخدام واجهة برمجة تطبيقات توقيت المستخدم الأصلية في المتصفّح. تختار حزمة تطوير البرامج (SDK) لمراقبة الأداء تلقائيًا مدة التتبّع التي يتم قياسها باستخدام واجهة برمجة التطبيقات هذه. يُعدّ استخدام User Timing API مفيدًا بشكل خاص إذا كنت تفضّل تحميل حزمة تطوير البرامج (SDK) لمراقبة الأداء بشكل غير متزامن. بمجرد إعداد حزمة 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 إذا كنت تريد إضافة هذه العناصر المخصّصة إلى تتبُّع رمز مخصّص.

إضافة مقاييس مخصّصة إلى عمليات تتبُّع الرموز المخصّصة

استخدِم Trace 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) لمراقبة الأداء المتوافق مع معالجة البيانات في الوقت الفعلي. مزيد من المعلومات عن بيانات الأداء في الوقت الفعلي

تتبُّع مقاييس محددة في لوحة البيانات

للتعرّف على مدى رواج المقاييس الرئيسية، أضِفها إلى لوحة المقاييس في أعلى لوحة بيانات الأداء. يمكنك التعرّف سريعًا على حالات التراجع من خلال الاطّلاع على التغييرات من أسبوع لآخر أو التحقّق من أنّ التغييرات الأخيرة في الرمز البرمجي تحسّن الأداء.

صورة للوحة المقاييس في لوحة بيانات "مراقبة أداء Firebase"

لإضافة مقياس إلى لوحة المقاييس، اتّبِع الخطوات التالية:

  1. انتقِل إلى لوحة بيانات الأداء في وحدة تحكُّم Firebase.
  2. انقر على بطاقة مقياس فارغة، ثم اختَر مقياسًا حاليًا لإضافته إلى لوحتك.
  3. انقر على في بطاقة مقياس تمت تعبئتها للاطّلاع على مزيد من الخيارات، مثل استبدال مقياس أو إزالته.

تعرض لوحة المقاييس بيانات المقاييس التي تم جمعها بمرور الوقت، سواء في شكل رسوم بيانية أو كنسبة مئوية رقمية.

اطّلِع على مزيد من المعلومات حول استخدام لوحة البيانات.

عرض عمليات التتبُّع وبياناتها

لعرض بيانات التتبُّع، انتقِل إلى لوحة بيانات الأداء في "وحدة تحكُّم Firebase"، وانتقِل للأسفل إلى جدول بيانات التتبُّع، ثم انقر على علامة التبويب الفرعية المناسبة. يعرض الجدول بعض أهم المقاييس لكل عملية تتبُّع، ويمكنك ترتيب القائمة حسب النسبة المئوية للتغيير لمقياس معيّن.

توفّر "مراقبة الأداء" صفحة لتحديد المشاكل وحلّها في "وحدة تحكُّم Firebase" تسلّط الضوء على التغييرات في المقاييس، ما يسهِّل معالجة مشاكل الأداء في تطبيقاتك ومستخدميها بسرعة وتقليل تأثيرها. يمكنك استخدام صفحة تحديد المشاكل وحلّها عند التعرّف على مشاكل محتملة في الأداء، مثلاً في السيناريوهات التالية:

  • ما عليك سوى تحديد المقاييس ذات الصلة على لوحة المعلومات وتلاحظ فارقًا كبيرًا.
  • يمكنك ترتيب البيانات في جدول بيانات التتبّع لعرض أكبر دلتا في أعلى الصفحة، وستلاحظ حدوث تغيير كبير في النسبة المئوية.
  • ستتلقّى تنبيهًا عبر البريد الإلكتروني لإعلامك بمشكلة في الأداء.

يمكنك الوصول إلى صفحة تحديد المشاكل وحلّها بالطرق التالية:

  • في لوحة بيانات المقاييس، انقر على الزر عرض تفاصيل المقياس.
  • في أيّ بطاقة مقياس، اختَر => عرض التفاصيل. تعرض صفحة تحديد المشاكل وحلّها معلومات حول المقياس الذي اخترته.
  • في جدول بيانات التتبّع، انقر على اسم عملية التتبّع أو أي قيمة مقياس في الصف المرتبط بسجلّ التتبّع هذا.
  • في تنبيه عبر البريد الإلكتروني، انقر على التحقيق الآن.

عند النقر على اسم عملية التتبّع في جدول بيانات التتبُّع، يمكنك التوغّل في المقاييس التي تهمك. انقر على الزر فلترة لفلترة البيانات حسب السمة، على سبيل المثال:

صورة لبيانات "مراقبة أداء Firebase" التي تتم فلترتها حسب السمة
  • يمكنك الفلترة حسب عنوان URL للصفحة لعرض بيانات صفحة محدّدة من موقعك الإلكتروني.
  • الفلترة حسب نوع الاتصال الفعّال لمعرفة مدى تأثير اتصال شبكة الجيل الثالث في تطبيقك
  • الفلترة حسب البلد للتأكد من أنّ الموقع الجغرافي لقاعدة البيانات لا يؤثر في منطقة معيّنة

اطّلِع على مزيد من المعلومات حول عرض بيانات عمليات التتبّع.

الخطوات التالية

  • اطّلِع على مزيد من المعلومات حول استخدام السمات لفحص بيانات الأداء.

  • اطّلِع على المزيد من المعلومات عن كيفية تتبُّع مشاكل الأداء في وحدة تحكُّم Firebase.

  • إعداد تنبيهات لتغييرات الرموز التي تؤدي إلى خفض مستوى أداء تطبيقك. على سبيل المثال، يمكنك ضبط تنبيه عبر البريد الإلكتروني لفريقك في حال تجاوزت مدة تتبُّع الرموز المخصّصة الحدّ الذي حدّدته.