افزودن پایش سفارشی برای کد برنامه خاص


«پایش عملکرد» ردگیری‌ها را جمع‌آوری می‌کند تا به شما کمک کند عملکرد برنامه‌تان را پایش کنید. ردگیری گزارشی از داده‌های عملکرد است که بین دو نقطه زمانی در برنامه‌تان ضبط شده است.

می‌توانید ردگیری‌های خودتان را برای نظارت بر داده‌های عملکرد مرتبط با کد خاصی در برنامه‌تان ایجاد کنید. با ردگیری کد سفارشی، می‌توانید مدت‌زمان لازم برای تکمیل تکلیف خاص یا مجموعه‌ای از تکالیف را در برنامه‌تان اندازه‌گیری کنید، برای مثال بار کردن مجموعه‌ای از تصاویر یا جستجوی پایگاه داده‌تان.

سنجه پیش‌فرض برای ردیابی کد سفارشی «مدت» آن است (زمان بین نقطه شروع و توقف ردیابی)، اما می‌توانید سنجه‌های سفارشی را نیز اضافه کنید.

در کدتان، ابتدا و انتهای ردگیری کد سفارشی را بااستفاده از میاناهای برنامه‌سازی کاربردی ارائه‌شده توسط کیت توسعه نرم‌افزار «پایش عملکرد» تعریف می‌کنید.

ردیابی‌های کد سفارشی را می‌توان در هر زمانی پس‌از ایجاد آن‌ها شروع کرد و آن‌ها رشته ایمن هستند.

ازآنجایی‌که سنجه پیش‌فرض جمع‌آوری‌شده برای این ردگیری‌ها «مدت» است، گاهی به آن‌ها «ردگیری‌های مدت» گفته می‌شود.

می‌توانید داده‌های این ردیابی‌ها را در زیربرگه ردیابی‌های سفارشی جدول ردیابی‌ها مشاهده کنید که در پایین داشبورد عملکرد قرار دارد (در ادامه این صفحه درباره استفاده از کنسول بیشتر بدانید).

مشخصه‌های پیش‌فرض، مشخصه‌های سفارشی، و سنجه‌های سفارشی

برای ردیابی‌های کد سفارشی، «پایش عملکرد» به‌طور خودکار ویژگی‌های پیش‌فرض (فراداده‌های رایج مانند نسخه برنامه، کشور، دستگاه، و غیره) را ثبت می‌کند تا بتوانید داده‌ها را برای ردیابی در کنسول Firebase فیلتر کنید. همچنین می‌توانید مشخصه‌های سفارشی (مثل سطح بازی یا ویژگی‌های کاربر) را اضافه و پایش کنید.

می‌توانید ردگیری کد سفارشی را بیشتر پیکربندی کنید تا سنجه‌های سفارشی را برای رویدادهای مرتبط با عملکرد که در محدوده ردگیری رخ می‌دهند ضبط کند. برای مثال، می‌توانید سنجه‌ای سفارشی برای تعداد دفعات موفقیت و عدم موفقیت حافظه نهان یا تعداد دفعاتی که واسط کاربر برای مدت زمان قابل‌توجهی غیرقابل‌پاسخ می‌شود ایجاد کنید.

مشخصه‌های سفارشی و سنجه‌های سفارشی در کنسول Firebase در کنار مشخصه‌های پیش‌فرض و سنجه پیش‌فرض برای ردیابی نمایش داده می‌شوند.

افزودن ردیابی کد سفارشی

از Performance Monitoring Trace API برای افزودن ردیابی‌های کد سفارشی برای نظارت بر کد برنامه خاص استفاده کنید.

به موارد زیر توجه کنید:

  • برنامه می‌تواند چندین رد کد سفارشی داشته باشد.
  • بیش‌از یک ردیابی کد سفارشی می‌تواند به‌طور هم‌زمان اجرا شود.
  • نام‌های ردیابی کد سفارشی باید شرایط زیر را داشته باشند: بدون فاصله سفید در ابتدا یا انتها، بدون نویسه زیرخط (_) در ابتدا، و حداکثر طول ۱۰۰ نویسه.
  • ردیابی‌های کد سفارشی از افزودن سنجه‌های سفارشی و مشخصه‌های سفارشی پشتیبانی می‌کنند.

برای شروع و توقف ردیابی کد سفارشی، کدی را که می‌خواهید ردیابی کنید با کدی مشابه کد زیر بپوشانید:

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

افزودن سنجه‌های سفارشی به ردیابی‌های کد سفارشی

از Performance Monitoring Trace API برای افزودن سنجه‌های سفارشی به ردگیری‌های کد سفارشی استفاده کنید.

به موارد زیر توجه کنید:

  • نام سنجه‌های سفارشی باید شرایط زیر را داشته باشد: بدون فاصله سفید در ابتدا یا انتها، بدون نویسه زیرخط (_) در ابتدا، و حداکثر طول ۱۰۰ نویسه.
  • هر ردگیری کد سفارشی می‌تواند تا ۳۲ سنجه را ثبت کند (ازجمله سنجه پیش‌فرض مدت).

برای افزودن سنجه سفارشی، هر بار که رویداد رخ می‌دهد، خط کدی مشابه کد زیر اضافه کنید. برای مثال، این سنجه سفارشی رویدادهای مرتبط با عملکرد را که در برنامه‌تان رخ می‌دهد، مثل دفعات موفقیت حافظه پنهان یا تلاش‌های مجدد، می‌شمارد.

Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();

// Code you want to trace

customTrace.incrementMetric("metric-name", 1);

// More code

await customTrace.stop();

ایجاد مشخصه‌های سفارشی برای ردیابی‌های کد سفارشی

برای استفاده از مشخصه‌های سفارشی، کدی به برنامه‌تان اضافه کنید که مشخصه را تعریف کند و آن را با ردگیری کد سفارشی خاصی مرتبط کند. هرزمان بین شروع و توقف ردیابی می‌توانید مشخصه سفارشی را تنظیم کنید.

به موارد زیر توجه کنید:

  • نام‌های مشخصه‌های سفارشی باید شرایط زیر را داشته باشند: بدون فاصله سفید در ابتدا یا انتها، بدون نویسه زیرخط (_) در ابتدا، و حداکثر طول ۳۲ نویسه.

  • هر ردگیری کد سفارشی می‌تواند تا ۵ مشخصه سفارشی را ضبط کند.

  • نباید از مشخصه‌های سفارشی‌ای استفاده کنید که حاوی اطلاعاتی است که هویت فردی را برای Google مشخص می‌کند.

Trace trace = FirebasePerformance.instance.newTrace("test_trace");

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

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

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

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();

ردگیری، مشاهده، و فیلتر کردن داده‌های عملکرد

ردگیری سنجه‌های خاص در داشبورد

برای اینکه بدانید سنجه‌های کلیدی‌تان چه روندی دارند، آن‌ها را به تابلو سنجه‌هایتان در بالای داشبورد عملکرد اضافه کنید. با دیدن تغییرات هفته‌به‌هفته می‌توانید به‌سرعت پس‌رفت‌ها را شناسایی کنید یا بررسی کنید که تغییرات اخیر در کدتان باعث بهبود عملکرد شده است یا نه.

برای افزودن سنجه به تابلو سنجه‌هایتان، به داشبورد عملکرد در کنسول Firebase بروید، سپس روی برگه داشبورد کلیک کنید. روی کارت سنجه خالی کلیک کنید، سپس سنجه موجودی را برای افزودن به تابلو انتخاب کنید. برای گزینه‌های بیشتر، مثل جایگزین کردن یا برداشتن سنجه، روی سه‌نقطه عمودی (⋮) در کارت سنجه پرشده کلیک کنید.

تابلو سنجه‌ها داده‌های سنجه جمع‌آوری‌شده را درطول زمان، هم به‌صورت گرافیکی و هم به‌صورت تغییر درصدی عددی، نشان می‌دهد.

درباره استفاده از داشبورد بیشتر بدانید.

مشاهده ردگیری‌ها و داده‌های آن‌ها

برای مشاهده ردیابی‌هایتان، به داشبورد عملکرد در کنسول Firebase بروید، به پایین پیمایش کنید تا به جدول ردیابی‌ها برسید، سپس روی زبانه فرعی مناسب کلیک کنید. جدول برخی‌از سنجه‌های برتر را برای هر ردگیری نمایش می‌دهد و حتی می‌توانید فهرست را براساس درصد تغییر برای سنجه‌ای خاص مرتب کنید.

اگر روی نام ردیابی در جدول ردیابی‌ها کلیک کنید، می‌توانید با کلیک کردن روی صفحه‌های مختلف، ردیابی را کاوش کنید و به جزئیات سنجه‌های موردعلاقه‌تان دسترسی پیدا کنید. در بیشتر صفحه‌ها، می‌توانید از دکمه فیلتر (بالا سمت راست صفحه) برای فیلتر کردن داده‌ها براساس مشخصه استفاده کنید، برای مثال:

  • براساس نسخه برنامه فیلتر کنید تا داده‌های مربوط به نسخه پخش قبلی یا جدیدترین نسخه پخش را مشاهده کنید
  • براساس دستگاه فیلتر کنید تا ببینید دستگاه‌های قدیمی‌تر چگونه با برنامه‌تان کار می‌کنند
  • براساس کشور فیلتر کنید تا مطمئن شوید مکان پایگاه داده‌تان بر منطقه خاصی تأثیر نمی‌گذارد

درباره مشاهده داده‌های ردیابی‌ها بیشتر بدانید.

مراحل بعدی

  • درباره استفاده از مشخصه‌ها برای بررسی داده‌های عملکرد بیشتر بدانید.

  • درباره نحوه ردیابی مشکلات عملکرد در کنسول Firebase بیشتر بدانید.

  • برای تغییرات کد که عملکرد برنامه‌تان را کاهش می‌دهد، هشدار تنظیم کنید. برای مثال، می‌توانید هشدار ایمیلی برای تیمتان پیکربندی کنید تا اگر مدت ردیابی کد سفارشی خاصی از آستانه‌ای که تنظیم کرده‌اید فراتر رفت، هشدار دریافت کنند.