نظارت بر عملکرد Firebase برای وب

1. بررسی اجمالی

در این کد لبه، یاد خواهید گرفت که چگونه از نظارت بر عملکرد Firebase برای اندازه گیری عملکرد یک برنامه وب چت استفاده کنید. برای دیدن نسخه نمایشی زنده به https://fireperf-friendlychat.web.app/ مراجعه کنید.

3b1284f5144b54f6.png

چیزی که یاد خواهید گرفت

  • نحوه افزودن نظارت بر عملکرد Firebase به برنامه وب خود برای دریافت معیارهای خارج از جعبه (بارگذاری صفحه و درخواست های شبکه).
  • چگونه یک قطعه کد خاص را با ردیابی های سفارشی اندازه گیری کنیم.
  • نحوه ثبت معیارهای اضافی و سفارشی مرتبط با یک ردیابی سفارشی.
  • چگونه داده های عملکرد خود را با ویژگی های سفارشی تقسیم بندی کنید.
  • چگونه از داشبورد نظارت بر عملکرد برای درک عملکرد برنامه وب خود استفاده کنید.

آنچه شما نیاز دارید

  • IDE یا ویرایشگر متن انتخابی شما، مانند WebStorm ، Atom ، Sublime یا VS Code
  • یک ترمینال/کنسول
  • مرورگر دلخواه شما، مانند کروم
  • کد نمونه کد آزمایشگاه (برای نحوه دریافت کد به بخش بعدی این کد لبه مراجعه کنید.)

2. کد نمونه را دریافت کنید

مخزن GitHub کد لبه را از خط فرمان کلون کنید:

git clone https://github.com/firebase/codelab-friendlychat-web

همچنین، اگر git را نصب نکرده‌اید، می‌توانید مخزن را به صورت یک فایل فشرده دانلود کنید .

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

با استفاده از IDE خود، دایرکتوری 📁 performance-monitoring-start از مخزن کلون شده باز کنید یا وارد کنید. این دایرکتوری 📁 performance-monitoring-start حاوی کد شروع برای codelab است که یک برنامه وب چت است.

3. یک پروژه Firebase ایجاد و راه اندازی کنید

یک پروژه Firebase ایجاد کنید

  1. در کنسول Firebase ، روی Add Project کلیک کنید.
  2. نام پروژه Firebase خود را FriendlyChat بگذارید.

شناسه پروژه برای پروژه Firebase خود را به خاطر بسپارید.

  1. روی ایجاد پروژه کلیک کنید.

یک برنامه وب Firebase را به پروژه اضافه کنید

  1. روی نماد وب کلیک کنید 58d6543a156e56f9.png برای ایجاد یک برنامه وب Firebase جدید.
  2. برنامه را با نام مستعار Friendly Chat ثبت کنید، و سپس کادر کناری همچنین راه اندازی میزبانی Firebase برای این برنامه را علامت بزنید.
  3. روی ثبت برنامه کلیک کنید.
  4. روی مراحل باقی مانده کلیک کنید. اکنون نیازی به دنبال کردن دستورالعمل های روی صفحه ندارید. این موارد در مراحل بعدی این نرم افزار کد پوشش داده خواهد شد.

ea9ab0db531a104c.png

ورود به سیستم Google را برای احراز هویت Firebase فعال کنید

برای اینکه کاربران بتوانند با حساب‌های Google خود وارد برنامه چت شوند، از روش ورود به سیستم Google استفاده می‌کنیم.

شما باید ورود به سیستم Google را فعال کنید:

  1. در کنسول Firebase، قسمت Develop را در پانل سمت چپ پیدا کنید.
  2. روی Authentication کلیک کنید، سپس روی برگه روش ورود به سیستم ( به کنسول بروید ) کلیک کنید.
  3. ارائه دهنده ورود به سیستم Google را فعال کنید و سپس روی ذخیره کلیک کنید.

7f3040a646c2e502.png

Cloud Firestore را فعال کنید

برنامه وب از Cloud Firestore برای ذخیره پیام های چت و دریافت پیام های چت جدید استفاده می کند.

باید Cloud Firestore را فعال کنید:

  1. در بخش توسعه کنسول Firebase، روی پایگاه داده کلیک کنید.
  2. روی ایجاد پایگاه داده در پنجره Cloud Firestore کلیک کنید.
  3. گزینه Start in test mode را انتخاب کنید، سپس پس از خواندن سلب مسئولیت در مورد قوانین امنیتی، روی Enable کلیک کنید.

کد شروع برای این نرم افزار کد شامل قوانین ایمن تر است. ما آنها را بعداً در Codelab مستقر خواهیم کرد.

24bd1a097492eac6.png

Cloud Storage را فعال کنید

برنامه وب از Cloud Storage برای Firebase برای ذخیره، آپلود و اشتراک‌گذاری تصاویر استفاده می‌کند.

باید Cloud Storage را فعال کنید:

  1. در بخش توسعه کنسول Firebase، روی Storage کلیک کنید.
  2. روی Get Started کلیک کنید.
  3. سلب مسئولیت مربوط به قوانین امنیتی پروژه Firebase خود را بخوانید و سپس روی Got it کلیک کنید.

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

4. رابط خط فرمان Firebase را نصب کنید

رابط خط فرمان Firebase (CLI) به شما امکان می دهد از میزبانی Firebase برای ارائه برنامه وب خود به صورت محلی و همچنین برای استقرار برنامه وب خود در پروژه Firebase خود استفاده کنید.

  1. با دنبال کردن این دستورالعمل ها در اسناد Firebase، CLI را نصب کنید.
  2. با اجرای دستور زیر در ترمینال، بررسی کنید که CLI به درستی نصب شده است:
firebase --version

مطمئن شوید که نسخه Firebase CLI شما نسخه 8.0.0 یا جدیدتر است.

  1. با اجرای دستور زیر Firebase CLI را مجاز کنید:
firebase login

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

  1. اطمینان حاصل کنید که خط فرمان شما به دایرکتوری محلی performance-monitoring-start برنامه شما دسترسی دارد.
  2. برنامه خود را با اجرای دستور زیر با پروژه Firebase خود مرتبط کنید:
firebase use --add
  1. وقتی از شما خواسته شد ID پروژه خود را انتخاب کنید و سپس به پروژه Firebase خود یک نام مستعار بدهید.

اگر چندین محیط (تولید، صحنه سازی و غیره) دارید، نام مستعار مفید است. با این حال، برای این کد لبه، اجازه دهید فقط از نام مستعار default استفاده کنیم.

  1. دستورالعمل های باقی مانده را در خط فرمان خود دنبال کنید.

5. ادغام با Firebase Performance Monitoring

راه های مختلفی برای ادغام با Firebase Performance Monitoring SDK برای وب وجود دارد (برای جزئیات به مستندات مراجعه کنید). در این لبه کد، نظارت بر عملکرد را از URL های میزبانی فعال می کنیم.

نظارت بر عملکرد را اضافه کنید و Firebase را مقداردهی اولیه کنید

  1. فایل src/index.js را باز کنید، سپس خط زیر را در زیر TODO اضافه کنید تا Firebase Performance Monitoring SDK را نیز شامل شود.

index.js

// TODO: Import the Firebase Performance Monitoring library here.
 import {
   getPerformance,
   trace
 } from 'firebase/performance';
  1. همچنین باید Firebase SDK را با یک شی پیکربندی که حاوی اطلاعات پروژه Firebase و برنامه وب مورد استفاده ما است، مقداردهی اولیه کنیم. از آنجایی که ما از میزبانی Firebase استفاده می کنیم، می توانید اسکریپت خاصی را وارد کنید که این پیکربندی را برای شما انجام می دهد. برای این کد لبه، ما قبلاً خط زیر را در پایین فایل public/index.html برای شما اضافه کرده‌ایم، اما دوباره بررسی کنید که وجود دارد.

index.html

<!-- This script is created by webpack -->
<script type="module" src="scripts/main.js"></script>
  1. در فایل src/index.js ، خط زیر را در زیر TODO اضافه کنید تا نظارت بر عملکرد مقداردهی شود.

index.js

// TODO: Initialize Firebase Performance Monitoring.
getPerformance();

وقتی کاربران از سایت شما استفاده می کنند، نظارت بر عملکرد به طور خودکار معیارهای بار صفحه و درخواست شبکه را برای شما جمع آوری می کند! برای کسب اطلاعات بیشتر در مورد ردیابی بارگذاری خودکار صفحه ، به مستندات مراجعه کنید .

اولین کتابخانه polyfill تاخیر ورودی را اضافه کنید

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

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

این کتابخانه polyfill برای یکپارچه سازی نظارت بر عملکرد اختیاری است.

فایل public/index.html را باز کنید، سپس خط زیر را از نظر خارج کنید.

index.html

<!-- TODO: Enable First Input Delay polyfill library. -->
<script type="text/javascript">!function(n,e){var t,o,i,c=[],f={passive:!0,capture:!0},r=new Date,a="pointerup",u="pointercancel";function p(n,c){t||(t=c,o=n,i=new Date,w(e),s())}function s(){o>=0&&o<i-r&&(c.forEach(function(n){n(o,t)}),c=[])}function l(t){if(t.cancelable){var o=(t.timeStamp>1e12?new Date:performance.now())-t.timeStamp;"pointerdown"==t.type?function(t,o){function i(){p(t,o),r()}function c(){r()}function r(){e(a,i,f),e(u,c,f)}n(a,i,f),n(u,c,f)}(o,t):p(o,t)}}function w(n){["click","mousedown","keydown","touchstart","pointerdown"].forEach(function(e){n(e,l,f)})}w(n),self.perfMetrics=self.perfMetrics||{},self.perfMetrics.onFirstInputDelay=function(n){c.push(n),s()}}(addEventListener,removeEventListener);</script>

در این مرحله، ادغام با Firebase Performance Monitoring در کد خود را به پایان رسانده اید!

در مراحل زیر، با افزودن ردیابی های سفارشی با استفاده از Firebase Performance Monitoring آشنا می شوید. اگر می‌خواهید فقط ردیابی خودکار را جمع‌آوری کنید، به بخش «استقرار و شروع ارسال تصاویر» بروید.

6. یک ردیابی سفارشی به برنامه خود اضافه کنید

نظارت بر عملکرد به شما امکان می دهد تا ردیابی های سفارشی ایجاد کنید. یک ردیابی سفارشی گزارشی برای مدت زمان یک بلوک اجرا در برنامه شما است. شما شروع و پایان یک ردیابی سفارشی را با استفاده از API های ارائه شده توسط SDK تعریف می کنید.

  1. در فایل src/index.js ، یک شیء عملکردی دریافت کنید، سپس یک ردیابی سفارشی برای آپلود پیام تصویر ایجاد کنید.

index.js

// TODO: Create custom trace to monitor image upload.
const t = trace(perf, "saveImageMessage");
  1. برای ثبت یک ردیابی سفارشی، باید نقطه شروع و نقطه توقف ردیابی را مشخص کنید. شما می توانید یک ردیابی را به عنوان یک تایمر در نظر بگیرید.

index.js

// TODO: Start the "timer" for the custom trace.
t.start();

 ...

    // TODO: Stop the "timer" for the custom trace.
    t.stop();

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

7. یک معیار سفارشی به برنامه خود اضافه کنید.

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

  1. ردیابی سفارشی مرحله قبل (که در فایل src/index.js شما تعریف شده است) را پیدا کنید.
  2. خط زیر را در زیر TODO اضافه کنید تا اندازه تصویر آپلود شده ثبت شود.

index.js

 ...

// TODO: Record image size.
t.putMetric('imageSize', file.size);

 ...

این معیار نظارت بر عملکرد را قادر می سازد تا مدت زمان ردیابی سفارشی و همچنین اندازه تصویر آپلود شده را ثبت کند.

8. یک ویژگی سفارشی به برنامه خود اضافه کنید

با تکیه بر مراحل قبلی، می‌توانید ویژگی‌های سفارشی را روی ردیابی‌های سفارشی خود نیز جمع‌آوری کنید. ویژگی‌های سفارشی می‌توانند به تقسیم‌بندی داده‌ها بر اساس دسته‌های خاص برنامه شما کمک کنند. به عنوان مثال، می توانید نوع MIME فایل تصویر را جمع آوری کنید تا بررسی کنید که نوع MIME چگونه ممکن است بر عملکرد تأثیر بگذارد.

  1. از ردیابی سفارشی تعریف شده در فایل src/index.js خود استفاده کنید.
  2. خط زیر را در زیر TODO اضافه کنید تا نوع MIME تصویر آپلود شده را ضبط کنید.

index.js

 ...

// TODO: Record image MIME type.
t.putAttribute('imageType', file.type);

 ...

این ویژگی نظارت بر عملکرد را قادر می سازد تا مدت زمان ردیابی سفارشی را بر اساس نوع تصویر آپلود شده دسته بندی کند.

9. [Extend] با User Timing API یک ردیابی سفارشی اضافه کنید

Firebase Performance Monitoring SDK به گونه ای طراحی شده است که می تواند به صورت ناهمزمان بارگیری شود و بنابراین تأثیر منفی بر عملکرد برنامه های وب در حین بارگذاری صفحه نداشته باشد. قبل از بارگیری SDK، API نظارت بر عملکرد Firebase در دسترس نیست. در این سناریو، همچنان می‌توانید با استفاده از User Timing API ، ردیابی‌های سفارشی را اضافه کنید. Firebase performance SDK مدت زمان‌ها را از اندازه () می‌گیرد و آنها را به‌عنوان ردیابی سفارشی ثبت می‌کند.

ما می‌خواهیم مدت زمان بارگیری اسکریپت‌های استایل‌سازی برنامه را با استفاده از User Timeming API اندازه‌گیری کنیم.

  1. در فایل public/index.html ، خط زیر را اضافه کنید تا شروع بارگذاری اسکریپت های استایلینگ برنامه را مشخص کنید.

index.html

<!-- TODO: Mark the starting of `timer` for loading App Styling script. -->
<script type="text/javascript">performance && performance.mark('loadStylingStart');</script>
  1. خطوط زیر را اضافه کنید تا پایان بارگیری اسکریپت های استایلینگ برنامه را مشخص کنید و مدت زمان بین شروع و پایان را اندازه گیری کنید.

index.html

<!-- TODO: Mark the ending of `timer` for loading App Styling script. Measure the duration from start to end. -->
<script type="text/javascript">
  performance && performance.mark('loadStylingEnd');
  performance && performance.measure('loadStyling', 'loadStylingStart', 'loadStylingEnd');
</script>

ورودی که در اینجا ایجاد کرده اید به طور خودکار توسط Firebase Performance Monitoring جمع آوری می شود. بعداً می‌توانید یک ردیابی سفارشی به نام loadStyling را در کنسول Firebase Performance پیدا کنید.

10. مستقر و شروع به ارسال تصاویر کنید

استقرار در میزبانی Firebase

پس از اضافه کردن Firebase Performance Monitoring به کد خود، این مراحل را برای استقرار کد خود در Firebase Hosting دنبال کنید:

  1. اطمینان حاصل کنید که خط فرمان شما به دایرکتوری محلی performance-monitoring-start برنامه شما دسترسی دارد.
  2. با اجرای دستور زیر فایل های خود را در پروژه Firebase خود مستقر کنید:
firebase deploy
  1. کنسول باید موارد زیر را نمایش دهد:
=== Deploying to 'friendlychat-1234'...

i  deploying firestore, storage, hosting
i  storage: checking storage.rules for compilation errors...
✔  storage: rules file storage.rules compiled successfully
i  firestore: checking firestore.rules for compilation errors...
✔  firestore: rules file firestore.rules compiled successfully
i  storage: uploading rules storage.rules...
i  firestore: uploading rules firestore.rules...
i  hosting[friendlychat-1234]: beginning deploy...
i  hosting[friendlychat-1234]: found 8 files in ./public
✔  hosting[friendlychat-1234]: file upload complete
✔  storage: released rules storage.rules to firebase.storage/friendlychat-1234.appspot.com
✔  firestore: released rules firestore.rules to cloud.firestore
i  hosting[friendlychat-1234]: finalizing version...
✔  hosting[friendlychat-1234]: version finalized
i  hosting[friendlychat-1234]: releasing new version...
✔  hosting[friendlychat-1234]: release complete

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com
  1. از برنامه وب خود که اکنون به طور کامل با استفاده از میزبانی Firebase میزبانی شده است، در دو زیردامنه Firebase خود بازدید کنید: https://<projectId>.firebaseapp.com و https://<projectId>.web.app .

بررسی کنید که نظارت بر عملکرد فعال باشد

کنسول Firebase را باز کنید و به تب Performance بروید. اگر پیام خوشامدگویی را مشاهده کردید که "SDK شناسایی شد"، پس با موفقیت با Firebase Performance Monitoring ادغام شده اید!

30df67e5a07d03b0.png

ارسال پیام تصویری

با ارسال تصاویر در برنامه چت خود، مقداری داده عملکرد تولید کنید.

  1. پس از ورود به برنامه چت خود، روی دکمه آپلود تصویر کلیک کنید 13734cb66773e5a3.png .
  2. یک فایل تصویری را با استفاده از انتخابگر فایل انتخاب کنید.
  3. سعی کنید چندین تصویر ارسال کنید (چند نمونه در حالت public/images/ ذخیره می‌شوند) تا بتوانید توزیع معیارهای سفارشی و ویژگی‌های سفارشی را آزمایش کنید.

پیام های جدید باید در رابط کاربری برنامه به همراه تصاویر انتخابی شما نمایش داده شوند.

11. داشبورد را کنترل کنید

پس از استقرار برنامه وب خود و ارسال پیام های تصویری به عنوان کاربر، می توانید داده های عملکرد را در داشبورد نظارت بر عملکرد (در کنسول Firebase) بررسی کنید.

به داشبورد خود دسترسی پیدا کنید

  1. در کنسول Firebase ، پروژه‌ای را انتخاب کنید که برنامه Friendly Chat شما را دارد.
  2. در پانل سمت چپ، قسمت Quality را پیدا کرده و روی عملکرد کلیک کنید.

بررسی داده های روی دستگاه

پس از اینکه نظارت بر عملکرد داده های برنامه شما را پردازش کرد، برگه هایی را در بالای داشبورد خواهید دید. اگر هنوز هیچ داده یا برگه‌ای نمی‌بینید، حتماً بعداً دوباره بررسی کنید.

  1. روی تب On device کلیک کنید.
  • جدول بارگیری صفحه ، معیارهای مختلف عملکردی را نشان می دهد که نظارت بر عملکرد به طور خودکار هنگام بارگیری صفحه شما جمع آوری می کند.
  • جدول مدت زمان هر گونه ردیابی سفارشی را که در کد برنامه خود تعریف کرده اید نشان می دهد.
  1. روی saveImageMessage در جدول Durations کلیک کنید تا معیارهای خاصی را برای ردیابی مرور کنید.

e28758fd02d9ffac.png

  1. برای بررسی توزیع اندازه‌های تصویر، روی Aggregate کلیک کنید. می‌توانید معیاری را که برای اندازه‌گیری اندازه تصویر برای این ردیابی سفارشی اضافه کرده‌اید، ببینید.

c3cbcfc0c739a0a8.png

  1. روی Over time که در مرحله قبل در کنار Aggregate است کلیک کنید. همچنین می توانید مدت زمان ردیابی سفارشی را مشاهده کنید. برای بررسی جزئیات بیشتر، روی مشاهده بیشتر کلیک کنید.

16983baa31e05732.png

  1. در صفحه ای که باز می شود، می توانید با کلیک روی imageType ، داده های مدت زمان را بر اساس نوع MIME تصویر تقسیم کنید. این داده خاص به دلیل ویژگی imageType که به ردیابی سفارشی خود اضافه کرده اید، ثبت شده است.

8e5c9f32f42a1ca1.png

بررسی داده های شبکه

درخواست شبکه HTTP/S گزارشی است که زمان پاسخگویی و حجم بار تماس های شبکه را نشان می دهد.

  1. به صفحه اصلی داشبورد نظارت بر عملکرد برگردید.
  2. برای مشاهده لیستی از ورودی های درخواست شبکه برای برنامه وب خود، روی تب Network کلیک کنید.
  3. آن‌ها را مرور کنید تا درخواست‌های کند را شناسایی کنید و شروع به کار بر روی یک راه حل برای بهبود عملکرد برنامه خود کنید!

26a2be152a77ffb9.png

12. تبریک می گویم!

شما Firebase SDK را برای نظارت بر عملکرد فعال کرده اید و ردیابی های خودکار و ردیابی های سفارشی را برای اندازه گیری عملکرد واقعی برنامه چت خود جمع آوری کرده اید!

آنچه ما پوشش داده ایم:

  • افزودن Firebase Performance Monitoring SDK به برنامه وب خود.
  • اضافه کردن ردهای سفارشی به کد شما
  • ثبت معیارهای سفارشی مرتبط با ردیابی سفارشی.
  • بخش بندی داده های عملکرد با استفاده از ویژگی های سفارشی
  • درک نحوه استفاده از داشبورد نظارت بر عملکرد برای به دست آوردن بینش در مورد عملکرد برنامه خود.

بیشتر بدانید: