نظارت بر عملکرد، ردیابی‌هایی را جمع‌آوری می‌کند تا به شما در نظارت بر عملکرد برنامه‌تان کمک کند. ردیابی، گزارشی از داده‌های عملکرد است که بین دو نقطه زمانی در برنامه شما ثبت می‌شود.
شما می‌توانید ردیابی‌های خودتان را برای نظارت بر داده‌های عملکرد مرتبط با کد خاصی در برنامه‌تان ایجاد کنید. با ردیابی کد سفارشی ، می‌توانید مدت زمان لازم برای تکمیل یک کار خاص یا مجموعه‌ای از کارها توسط برنامه‌تان، مثلاً بارگذاری مجموعه‌ای از تصاویر یا پرس‌وجو از پایگاه داده‌تان را اندازه‌گیری کنید.
معیار پیش‌فرض برای ردیابی کد سفارشی، «مدت زمان» آن (زمان بین نقاط شروع و پایان ردیابی) است، اما می‌توانید معیارهای سفارشی نیز اضافه کنید.
در کد خود، ابتدا و انتهای یک ردیابی کد سفارشی را با استفاده از APIهای ارائه شده توسط Performance Monitoring SDK تعریف می‌کنید.
ردیابی کدهای سفارشی را می‌توان در هر زمانی پس از ایجاد آنها آغاز کرد و از نظر thread safe هستند.
از آنجایی که معیار پیش‌فرض جمع‌آوری‌شده برای این ردپاها «مدت زمان» است، گاهی اوقات به آنها «ردپاهای مدت زمان» نیز گفته می‌شود.
می‌توانید داده‌های این ردها را در زیربرگه ردهای سفارشی از جدول ردها، که در پایین داشبورد عملکرد قرار دارد، مشاهده کنید (در ادامه این صفحه درباره استفاده از کنسول بیشتر بدانید).
ویژگی‌های پیش‌فرض، ویژگی‌های سفارشی و معیارهای سفارشی
برای ردیابی کدهای سفارشی، Performance Monitoring به طور خودکار ویژگی‌های پیش‌فرض (فراداده‌های رایج مانند نسخه برنامه، کشور، دستگاه و غیره) را ثبت می‌کند تا بتوانید داده‌ها را برای ردیابی در کنسول Firebase فیلتر کنید. همچنین می‌توانید ویژگی‌های سفارشی (مانند سطح بازی یا ویژگی‌های کاربر) را اضافه و نظارت کنید.
شما می‌توانید یک ردیابی کد سفارشی را برای ثبت معیارهای سفارشی برای رویدادهای مرتبط با عملکرد که در محدوده ردیابی رخ می‌دهند، پیکربندی کنید. به عنوان مثال، می‌توانید یک معیار سفارشی برای تعداد موفقیت‌ها و شکست‌های حافظه پنهان یا تعداد دفعاتی که رابط کاربری برای یک دوره زمانی قابل توجه پاسخگو نیست، ایجاد کنید.
ویژگی‌های سفارشی و معیارهای سفارشی در کنسول Firebase در کنار ویژگی‌های پیش‌فرض و معیارهای پیش‌فرض برای ردیابی نمایش داده می‌شوند.
اضافه کردن رد کدهای سفارشی
از API ردیابی نظارت بر عملکرد برای اضافه کردن ردیابی کدهای سفارشی جهت نظارت بر کد برنامه خاص استفاده کنید.
به موارد زیر توجه کنید:
- یک برنامه می‌تواند چندین رد کد سفارشی داشته باشد.
- بیش از یک ردیابی کد سفارشی می‌تواند همزمان اجرا شود.
- نام‌های مربوط به ردیابی کدهای سفارشی باید الزامات زیر را داشته باشند: بدون فاصله‌ی خالی در ابتدا یا انتهای نام، بدون کاراکتر زیرخط (
_) در ابتدای نام، و حداکثر طول ۱۰۰ کاراکتر. - ردیابی کدهای سفارشی از اضافه کردن معیارها و ویژگی‌های سفارشی پشتیبانی می‌کند.
برای شروع و توقف ردیابی کد سفارشی، کدی را که می‌خواهید ردیابی شود، با کدی مشابه کد زیر بپوشانید:
Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();
// Code you want to trace
await customTrace.stop();
معیارهای سفارشی را به ردیابی‌های کد سفارشی اضافه کنید
از 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();
ایجاد ویژگی‌های سفارشی برای ردیابی کدهای سفارشی
برای استفاده از ویژگی‌های سفارشی، کدی را به برنامه خود اضافه کنید که ویژگی را تعریف می‌کند و آن را با یک ردیابی کد سفارشی خاص مرتبط می‌کند. می‌توانید ویژگی سفارشی را در هر زمانی بین شروع ردیابی و پایان ردیابی تنظیم کنید.
به موارد زیر توجه کنید:
نام‌های مربوط به ویژگی‌های سفارشی باید الزامات زیر را داشته باشند: بدون فاصله‌ی خالی در ابتدا یا انتهای نام، بدون کاراکتر زیرخط (
_) در ابتدای نام، و حداکثر طول نام ۳۲ کاراکتر.هر ردیابی کد سفارشی می‌تواند تا ۵ ویژگی سفارشی را ثبت کند.
شما نباید از ویژگی‌های سفارشی که حاوی اطلاعاتی هستند که هویت یک فرد را برای گوگل مشخص می‌کنند، استفاده کنید.
نظارت بر عملکرد به خودی خود هیچ گونه اطلاعات شخصی قابل شناسایی (PII) مانند نام، آدرس ایمیل یا شماره تلفن را جمع‌آوری نمی‌کند. توسعه‌دهندگان می‌توانند با ایجاد ویژگی‌های سفارشی در ردیابی کدهای سفارشی، داده‌های اضافی را با استفاده از نظارت بر عملکرد جمع‌آوری کنند. چنین داده‌هایی که از طریق نظارت بر عملکرد جمع‌آوری می‌شوند، نباید حاوی اطلاعاتی باشند که هویت شخصی یک فرد را برای گوگل مشخص کند.
در اینجا مثالی از یک پیام لاگ که حاوی اطلاعات شخصی قابل شناسایی نیست، آورده شده است:
customTrace.putAttribute("experiment", "A"); // OKدر اینجا مثالی آورده شده است که حاوی اطلاعات شخصی قابل شناسایی است (از این نوع ویژگی سفارشی در برنامه خود استفاده نکنید):
customTrace.putAttribute(("email", user.getEmailAddress()); // Don't do this!داده‌هایی که هرگونه اطلاعات شخصی قابل شناسایی را افشا کنند، بدون اطلاع قبلی حذف می‌شوند.
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 بروید، سپس روی برگه داشبورد کلیک کنید. روی یک کارت معیار خالی کلیک کنید، سپس یک معیار موجود را برای افزودن به برد خود انتخاب کنید. برای گزینه‌های بیشتر، مانند جایگزینی یا حذف یک معیار، روی حذف عمودی ( ⋮ ) روی یک کارت معیار پر شده کلیک کنید.
صفحه معیارها، داده‌های معیار جمع‌آوری‌شده را در طول زمان، هم به صورت گرافیکی و هم به صورت درصد تغییر عددی، نشان می‌دهد.
درباره استفاده از داشبورد بیشتر بدانید.
مشاهده ردپاها و داده‌های آنها
برای مشاهده‌ی ردپاهای خود، به داشبورد Performance در کنسول Firebase بروید، به پایین صفحه بروید تا به جدول ردپاها برسید، سپس روی زیربرگه‌ی مربوطه کلیک کنید. جدول، برخی از معیارهای برتر را برای هر ردپا نمایش می‌دهد و حتی می‌توانید لیست را بر اساس درصد تغییر برای یک معیار خاص مرتب کنید.
اگر روی نام یک رد در جدول ردها کلیک کنید، می‌توانید روی صفحات مختلف کلیک کنید تا رد را بررسی کرده و معیارهای مورد علاقه خود را بررسی کنید. در بیشتر صفحات، می‌توانید از دکمه فیلتر (بالا سمت چپ صفحه) برای فیلتر کردن داده‌ها بر اساس ویژگی استفاده کنید، به عنوان مثال:
- برای مشاهده اطلاعات مربوط به نسخه قبلی یا آخرین نسخه، بر اساس نسخه برنامه فیلتر کنید
- برای اطلاع از نحوه مدیریت برنامه توسط دستگاه‌های قدیمی‌تر، آن را بر اساس دستگاه فیلتر کنید
- بر اساس کشور فیلتر کنید تا مطمئن شوید موقعیت مکانی پایگاه داده شما بر منطقه خاصی تأثیر نمی‌گذارد
درباره مشاهده داده‌های ردپاهایتان بیشتر بدانید.
مراحل بعدی
درباره استفاده از ویژگی‌ها برای بررسی داده‌های عملکرد بیشتر بدانید.
درباره نحوه ردیابی مشکلات عملکرد در کنسول Firebase بیشتر بدانید.
برای تغییرات کدی که عملکرد برنامه شما را کاهش می‌دهند ، هشدار تنظیم کنید . به عنوان مثال، می‌توانید یک هشدار ایمیلی برای تیم خود پیکربندی کنید اگر مدت زمان ردیابی یک کد سفارشی خاص از آستانه‌ای که تعیین کرده‌اید فراتر رود.