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


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

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

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

در کد خود، ابتدا و انتهای یک ردیابی کد سفارشی را با استفاده از API های ارائه شده توسط Performance Monitoring SDK تعریف می کنید.برای برنامه‌های Android، می‌توانید با استفاده از حاشیه‌نویسی @AddTrace روش‌های خاصی را نیز نظارت کنید.ردیابی کد سفارشی را می توان در هر زمانی پس از ایجاد آنها شروع کرد و آنها را در حالت ایمن قرار داد.

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

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

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

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

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

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

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

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

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

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

برای شروع و توقف یک ردیابی کد سفارشی، کدی را که می‌خواهید ردیابی کنید با خطوط کدی مشابه زیر بپیچید (این مثال از یک نام ردیابی سفارشی test_trace استفاده می‌کند):

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace

myTrace.stop()

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace

myTrace.stop();

(اختیاری) روش های خاص را با استفاده از @AddTrace نظارت کنید

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

به عنوان مثال، می توانید یک ردیابی کد سفارشی به نام onCreateTrace ایجاد کنید که با فراخوانی متد onCreate() اجرا می شود.

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
// the `enabled` argument is optional and defaults to true
@AddTrace(name = "onCreateTrace", enabled = true)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}

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

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

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

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

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

Kotlin+KTX

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace (and log custom metrics)
val item = cache.fetch("item")
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1)
} else {
    myTrace.incrementMetric("item_cache_miss", 1)
}

myTrace.stop()

Java

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace (and log custom metrics)
Item item = cache.fetch("item");
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1);
} else {
    myTrace.incrementMetric("item_cache_miss", 1);
}

myTrace.stop();

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

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

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

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

  • نام‌های ویژگی‌های سفارشی باید شرایط زیر را داشته باشند:

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

  • لطفاً مطمئن شوید که ویژگی‌های سفارشی حاوی اطلاعاتی نیستند که شخصاً یک فرد را در Google شناسایی کند.

    درباره این دستورالعمل بیشتر بدانید

Kotlin+KTX

Firebase.performance.newTrace("test_trace").trace {
    // Update scenario.
    putAttribute("experiment", "A")

    // Reading scenario.
    val experimentValue = getAttribute("experiment")

    // Delete scenario.
    removeAttribute("experiment")

    // Read attributes.
    val traceAttributes = this.attributes
}

Java

Trace trace = FirebasePerformance.getInstance().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();

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

معیارهای خاص را در داشبورد خود ردیابی کنید

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

تصویری از تابلوی متریک در <span class= داشبورد نظارت بر عملکرد Firebase" />

برای افزودن یک معیار به تابلوی سنجش خود، این مراحل را دنبال کنید:

  1. به داشبورد Performance در کنسول Firebase بروید.
  2. روی یک کارت متریک خالی کلیک کنید، سپس یک معیار موجود را برای افزودن به تابلوی خود انتخاب کنید.
  3. برای گزینه های بیشتر، به عنوان مثال برای جایگزینی یا حذف یک معیار، روی روی کارت متریک پر شده کلیک کنید.

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

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

مشاهده آثار و داده های آنها

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

Performance Monitoring یک صفحه عیب‌یابی در کنسول Firebase ارائه می‌کند که تغییرات متریک را برجسته می‌کند و رسیدگی سریع و به حداقل رساندن تأثیر مشکلات عملکرد بر برنامه‌ها و کاربران را آسان می‌کند. برای مثال در سناریوهای زیر می‌توانید از صفحه عیب‌یابی استفاده کنید.

  • معیارهای مربوطه را روی داشبورد انتخاب می‌کنید و متوجه یک دلتای بزرگ می‌شوید.
  • در جدول ردیابی برای نمایش بزرگترین دلتاها در بالا مرتب می کنید و درصد تغییر قابل توجهی را مشاهده می کنید.
  • شما یک هشدار ایمیلی دریافت می‌کنید که شما را از مشکل عملکرد مطلع می‌کند.

از راه های زیر می توانید به صفحه عیب یابی دسترسی پیدا کنید:

  • در داشبورد متریک، روی دکمه مشاهده جزئیات متریک کلیک کنید.
  • در هر کارت متریک، را انتخاب کنید => مشاهده جزئیات . صفحه عیب‌یابی اطلاعاتی را درباره معیاری که انتخاب کرده‌اید نمایش می‌دهد.
  • در جدول ردیابی، روی نام ردیابی یا هر مقدار متریک در ردیف مرتبط با آن ردیابی کلیک کنید.
  • در یک هشدار ایمیل، روی بررسی اکنون کلیک کنید.

هنگامی که روی نام ردیابی در جدول ردیابی کلیک می کنید، سپس می توانید معیارهای مورد علاقه را بررسی کنید. را کلیک کنید دکمه فیلتر برای فیلتر کردن داده ها بر اساس ویژگی، به عنوان مثال:

تصویری از <span class= داده های نظارت بر عملکرد Firebase با ویژگی فیلتر می شوند" />
  • بر اساس نسخه برنامه فیلتر کنید تا داده‌های مربوط به نسخه قبلی یا آخرین نسخه خود را مشاهده کنید
  • بر اساس دستگاه فیلتر کنید تا بدانید دستگاه های قدیمی چگونه برنامه شما را مدیریت می کنند
  • بر اساس کشور فیلتر کنید تا مطمئن شوید مکان پایگاه داده شما بر منطقه خاصی تأثیر نمی گذارد

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

مراحل بعدی

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