نظارت سفارشی برای کد برنامه خاص اضافه کنید


نظارت بر عملکرد ردیابی هایی را جمع آوری می کند تا به شما در نظارت بر عملکرد برنامه خود کمک کند. ردیابی گزارشی از داده های عملکردی است که بین دو نقطه از زمان در برنامه شما ثبت شده است.

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

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

در کد خود، ابتدا و انتهای یک ردیابی کد سفارشی را با استفاده از API های ارائه شده توسط Performance Monitoring SDK تعریف می کنید.

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

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

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

ویژگی‌های پیش‌فرض، ویژگی‌های سفارشی و معیارهای سفارشی

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

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

ویژگی‌های سفارشی و معیارهای سفارشی در کنسول Firebase در کنار ویژگی‌های پیش‌فرض و متریک پیش‌فرض برای ردیابی نمایش داده می‌شوند.

ردیابی کد سفارشی را اضافه کنید

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

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

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

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

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

// Code you want to trace

await customTrace.stop();

معیارهای سفارشی را به ردیابی کد سفارشی اضافه کنید

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

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

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

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

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

ایجاد ویژگی های سفارشی برای ردیابی کد سفارشی

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

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

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

  • هر ردیابی کد سفارشی می تواند تا 5 ویژگی سفارشی را ثبت کند.

  • شما نباید از ویژگی های سفارشی استفاده کنید که حاوی اطلاعاتی است که شخصاً یک فرد را در 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 بروید، به جدول ردیابی‌ها بروید و سپس روی زیربرگه مناسب کلیک کنید. جدول برخی از معیارهای برتر را برای هر ردیابی نشان می دهد، و حتی می توانید لیست را بر اساس درصد تغییر برای یک معیار خاص مرتب کنید.

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

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

درباره مشاهده داده های ردیابی خود بیشتر بیاموزید.

مراحل بعدی