1. Khái quát chung
Trong phòng thí nghiệm lập trình này, bạn sẽ tìm hiểu cách sử dụng Giám sát hiệu suất Firebase để đo lường hiệu suất của ứng dụng web trò chuyện. Truy cập https://fireperf-friendlychat.web.app/ để xem bản trình diễn trực tiếp.
Bạn sẽ học được gì
- Cách thêm Giám sát hiệu suất Firebase vào ứng dụng web của bạn để nhận các chỉ số vượt trội (tải trang và yêu cầu mạng).
- Cách đo lường một đoạn mã cụ thể bằng các dấu vết tùy chỉnh.
- Cách ghi lại các chỉ số tùy chỉnh, bổ sung được gắn với một dấu vết tùy chỉnh.
- Cách phân đoạn thêm dữ liệu hiệu suất của bạn với các thuộc tính tùy chỉnh.
- Cách sử dụng bảng điều khiển theo dõi hiệu suất để hiểu hiệu suất của ứng dụng web của bạn.
Những gì bạn cần
2. Lấy mã mẫu
Sao chép kho lưu trữ GitHub của phòng thí nghiệm mã từ dòng lệnh:
git clone https://github.com/firebase/codelab-friendlychat-web
Ngoài ra, nếu bạn chưa cài đặt git, bạn có thể tải xuống repo dưới dạng tệp zip .
Nhập ứng dụng khởi động
Sử dụng IDE của bạn, mở hoặc nhập thư mục 📁 performance-monitoring-start từ kho lưu trữ nhân bản. 📁 Thư mục performance-monitoring-start này chứa mã bắt đầu cho phòng thí nghiệm viết mã, đây là một ứng dụng web trò chuyện.
3. Tạo và thiết lập dự án Firebase
Tạo dự án Firebase
- Trong bảng điều khiển Firebase , nhấp vào Thêm dự án .
- Đặt tên cho dự án Firebase của bạn
FriendlyChat.
Ghi nhớ ID dự án cho dự án Firebase của bạn.
- Nhấp vào Tạo dự án .
Thêm ứng dụng web Firebase vào dự án
- Nhấp vào biểu tượng web
để tạo ứng dụng web Firebase mới. - Đăng ký ứng dụng với biệt hiệu
Friendly Chat, sau đó chọn hộp bên cạnh Đồng thời thiết lập Dịch vụ lưu trữ Firebase cho ứng dụng này . - Nhấp vào Đăng ký ứng dụng .
- Nhấp qua các bước còn lại. Bây giờ bạn không cần phải làm theo các hướng dẫn trên màn hình; những điều này sẽ được đề cập trong các bước sau của bài học lập trình này.
Bật đăng nhập Google để xác thực Firebase
Để cho phép người dùng đăng nhập vào ứng dụng trò chuyện bằng tài khoản Google của họ, chúng tôi sẽ sử dụng phương thức đăng nhập Google .
Bạn sẽ cần bật đăng nhập bằng Google :
- Trong bảng điều khiển Firebase, tìm phần Phát triển trong bảng điều khiển bên trái.
- Nhấp vào Xác thực , sau đó nhấp vào tab Phương thức đăng nhập ( đi tới bảng điều khiển ).
- Bật nhà cung cấp dịch vụ đăng nhập Google rồi nhấp vào Lưu .
Kích hoạt Cloud Firestore
Ứng dụng web sử dụng Cloud Firestore để lưu tin nhắn trò chuyện và nhận tin nhắn trò chuyện mới.
Bạn sẽ cần bật Cloud Firestore:
- Trong phần Phát triển của bảng điều khiển Firebase, hãy nhấp vào Cơ sở dữ liệu .
- Nhấp vào Tạo cơ sở dữ liệu trong khung Cloud Firestore.
- Chọn tùy chọn Bắt đầu ở chế độ thử nghiệm , sau đó nhấp vào Bật sau khi đọc tuyên bố từ chối trách nhiệm về các quy tắc bảo mật.
Mã khởi động cho phòng học mã này bao gồm các quy tắc an toàn hơn. Chúng ta sẽ triển khai chúng sau trong phòng thí nghiệm lập trình.
Kích hoạt lưu trữ đám mây
Ứng dụng web sử dụng Cloud Storage cho Firebase để lưu trữ, tải lên và chia sẻ ảnh.
Bạn sẽ cần bật Lưu trữ đám mây:
- Trong phần Phát triển của bảng điều khiển Firebase, nhấp vào Lưu trữ .
- Nhấp vào Bắt đầu .
- Đọc tuyên bố từ chối trách nhiệm về các quy tắc bảo mật cho dự án Firebase của bạn, sau đó nhấp vào Hiểu rồi .
Mã bắt đầu bao gồm một quy tắc bảo mật cơ bản, quy tắc này chúng ta sẽ triển khai sau trong phòng thí nghiệm mã.
4. Cài đặt giao diện dòng lệnh Firebase
Giao diện dòng lệnh Firebase (CLI) cho phép bạn sử dụng Dịch vụ lưu trữ Firebase để phân phối ứng dụng web của bạn cục bộ cũng như triển khai ứng dụng web cho dự án Firebase của bạn.
- Cài đặt CLI bằng cách làm theo các hướng dẫn này trong tài liệu Firebase.
- Xác minh rằng CLI đã được cài đặt chính xác bằng cách chạy lệnh sau trong thiết bị đầu cuối:
firebase --version
Đảm bảo rằng phiên bản Firebase CLI của bạn là v8.0.0 trở lên.
- Cấp quyền cho Firebase CLI bằng cách chạy lệnh sau:
firebase login
Chúng tôi đã thiết lập mẫu ứng dụng web để lấy cấu hình ứng dụng của bạn cho Dịch vụ lưu trữ Firebase từ thư mục cục bộ của ứng dụng (kho lưu trữ mà bạn đã sao chép trước đó trong phòng thí nghiệm mã). Nhưng để kéo cấu hình, chúng tôi cần liên kết ứng dụng của bạn với dự án Firebase.
- Đảm bảo rằng dòng lệnh của bạn đang truy cập thư mục
performance-monitoring-startcủa ứng dụng. - Liên kết ứng dụng của bạn với dự án Firebase bằng cách chạy lệnh sau:
firebase use --add
- Khi được nhắc, hãy chọn ID dự án của bạn, sau đó đặt bí danh cho dự án Firebase của bạn.
Bí danh sẽ hữu ích nếu bạn có nhiều môi trường (sản xuất, dàn dựng, v.v.). Tuy nhiên, đối với codelab này, chúng ta hãy sử dụng bí danh là default .
- Thực hiện theo các hướng dẫn còn lại trong dòng lệnh của bạn.
5. Tích hợp với Giám sát hiệu suất Firebase
Có nhiều cách khác nhau để tích hợp với SDK giám sát hiệu suất Firebase dành cho web (tham khảo tài liệu để biết chi tiết). Trong phòng thí nghiệm lập trình này, chúng ta sẽ kích hoạt giám sát hiệu suất từ URL lưu trữ .
Thêm giám sát hiệu suất và khởi tạo Firebase
- Mở tệp
src/index.js, sau đó thêm dòng sau bên dướiTODOđể bao gồm SDK giám sát hiệu suất Firebase.
index.js
// TODO: Import the Firebase Performance Monitoring library here.
import {
getPerformance,
trace
} from 'firebase/performance';
- Chúng tôi cũng cần khởi tạo SDK Firebase với một đối tượng cấu hình chứa thông tin về dự án Firebase và ứng dụng web mà chúng tôi muốn sử dụng. Vì chúng tôi đang sử dụng Dịch vụ lưu trữ Firebase nên bạn có thể nhập một tập lệnh đặc biệt sẽ thực hiện cấu hình này cho bạn. Đối với phòng thí nghiệm mã này, chúng tôi đã thêm dòng sau cho bạn ở cuối tệp
public/index.html, nhưng hãy kiểm tra kỹ xem nó có ở đó không.
index.html
<!-- This script is created by webpack -->
<script type="module" src="scripts/main.js"></script>
- Trong tệp
src/index.js, hãy thêm dòng sau bên dướiTODOđể bắt đầu giám sát hiệu suất.
index.js
// TODO: Initialize Firebase Performance Monitoring.
getPerformance();
Giám sát hiệu suất giờ đây sẽ tự động thu thập số liệu tải trang và yêu cầu mạng cho bạn khi người dùng sử dụng trang web của bạn! Tham khảo tài liệu để tìm hiểu thêm về dấu vết tải trang tự động.
Thêm thư viện polyfill độ trễ đầu vào đầu tiên
Độ trễ đầu vào đầu tiên rất hữu ích vì trình duyệt phản hồi tương tác của người dùng mang lại cho người dùng ấn tượng đầu tiên về khả năng phản hồi của ứng dụng của bạn.
Độ trễ đầu vào đầu tiên bắt đầu khi người dùng tương tác lần đầu với một phần tử trên trang, chẳng hạn như nhấp vào nút hoặc siêu liên kết. Nó dừng ngay sau khi trình duyệt có thể phản hồi đầu vào, nghĩa là trình duyệt không bận tải hoặc phân tích nội dung của bạn.
Thư viện polyfill này là tùy chọn để tích hợp giám sát hiệu suất.
Mở tệp public/index.html , sau đó bỏ ghi chú dòng sau.
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>
Tại thời điểm này, bạn đã hoàn tất việc tích hợp tính năng Giám sát hiệu suất Firebase trong mã của mình!
Trong các bước sau, bạn sẽ tìm hiểu về cách thêm dấu vết tùy chỉnh bằng Giám sát hiệu suất Firebase. Nếu bạn chỉ muốn thu thập các dấu vết tự động, hãy chuyển đến phần "Triển khai và bắt đầu gửi hình ảnh".
6. Thêm dấu vết tùy chỉnh vào ứng dụng của bạn
Giám sát hiệu suất cho phép bạn tạo dấu vết tùy chỉnh . Dấu vết tùy chỉnh là một báo cáo về thời lượng của một khối thực thi trong ứng dụng của bạn. Bạn xác định điểm bắt đầu và điểm kết thúc của một theo dõi tùy chỉnh bằng cách sử dụng các API do SDK cung cấp.
- Trong tệp
src/index.js, lấy đối tượng hiệu suất, sau đó tạo dấu vết tùy chỉnh để tải thông báo hình ảnh lên.
index.js
// TODO: Create custom trace to monitor image upload.
const t = trace(perf, "saveImageMessage");
- Để ghi lại dấu vết tùy chỉnh, bạn cần chỉ định điểm bắt đầu và điểm dừng cho dấu vết. Bạn có thể nghĩ về một dấu vết như một bộ đếm thời gian.
index.js
// TODO: Start the "timer" for the custom trace.
t.start();
...
// TODO: Stop the "timer" for the custom trace.
t.stop();
Bạn đã xác định thành công một dấu vết tùy chỉnh! Sau khi triển khai mã của bạn, thời lượng của dấu vết tùy chỉnh sẽ được ghi lại nếu người dùng gửi tin nhắn hình ảnh. Điều này sẽ cung cấp cho bạn ý tưởng về thời gian người dùng trong thế giới thực gửi hình ảnh trong ứng dụng trò chuyện của bạn.
7. Thêm số liệu tùy chỉnh vào ứng dụng của bạn.
Bạn có thể định cấu hình thêm một theo dõi tùy chỉnh để ghi lại các số liệu tùy chỉnh cho các sự kiện liên quan đến hiệu suất xảy ra trong phạm vi của nó. Ví dụ: bạn có thể sử dụng số liệu để điều tra xem thời gian tải lên có bị ảnh hưởng bởi kích thước của hình ảnh đối với dấu vết tùy chỉnh mà chúng tôi đã xác định ở bước trước hay không.
- Định vị dấu vết tùy chỉnh từ bước trước đó (được xác định trong tệp
src/index.jscủa bạn). - Thêm dòng sau bên dưới
TODOđể ghi lại kích thước của hình ảnh được tải lên.
index.js
...
// TODO: Record image size.
t.putMetric('imageSize', file.size);
...
Số liệu này cho phép theo dõi hiệu suất để ghi lại thời lượng theo dõi tùy chỉnh cũng như kích thước hình ảnh được tải lên.
8. Thêm thuộc tính tùy chỉnh vào ứng dụng của bạn
Dựa trên các bước trước đó, bạn cũng có thể thu thập các thuộc tính tùy chỉnh trên các dấu vết tùy chỉnh của mình . Thuộc tính tùy chỉnh có thể giúp phân đoạn dữ liệu theo danh mục dành riêng cho ứng dụng của bạn. Ví dụ: bạn có thể thu thập loại MIME của tệp hình ảnh để điều tra xem loại MIME có thể ảnh hưởng đến hiệu suất như thế nào.
- Sử dụng dấu vết tùy chỉnh được xác định trong tệp
src/index.jscủa bạn. - Thêm dòng sau bên dưới
TODOđể ghi lại loại MIME của hình ảnh đã tải lên.
index.js
...
// TODO: Record image MIME type.
t.putAttribute('imageType', file.type);
...
Thuộc tính này cho phép theo dõi hiệu suất để phân loại thời lượng theo dõi tùy chỉnh dựa trên loại hình ảnh đã tải lên.
9. [Mở rộng] Thêm dấu vết tùy chỉnh với API thời gian người dùng
SDK giám sát hiệu suất Firebase được thiết kế để có thể tải không đồng bộ và do đó SDK sẽ không tác động tiêu cực đến hiệu suất của ứng dụng web trong khi tải trang. Trước khi SDK được tải, API giám sát hiệu suất Firebase không khả dụng. Trong trường hợp này, bạn vẫn có thể thêm dấu vết tùy chỉnh bằng cách sử dụng API Thời gian người dùng . SDK hiệu suất Firebase sẽ chọn thời lượng từ thước đo() và ghi lại chúng dưới dạng dấu vết tùy chỉnh.
Chúng tôi sẽ đo thời lượng tải tập lệnh tạo kiểu ứng dụng bằng API Thời gian người dùng.
- Trong tệp
public/index.html, hãy thêm dòng sau để đánh dấu thời điểm bắt đầu tải tập lệnh kiểu dáng ứng dụng.
index.html
<!-- TODO: Mark the starting of `timer` for loading App Styling script. -->
<script type="text/javascript">performance && performance.mark('loadStylingStart');</script>
- Thêm các dòng sau để đánh dấu kết thúc quá trình tải tập lệnh kiểu dáng ứng dụng và để đo khoảng thời gian giữa bắt đầu và kết thúc.
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>
Mục bạn đã tạo ở đây sẽ được tính năng Giám sát hiệu suất Firebase tự động thu thập. Sau này, bạn sẽ có thể tìm thấy dấu vết tùy chỉnh có tên là loadStyling trong bảng điều khiển Hiệu suất Firebase.
10. Triển khai và bắt đầu gửi ảnh
Triển khai lên Firebase Hosting
Sau khi thêm tính năng Giám sát hiệu suất Firebase vào mã của bạn, hãy làm theo các bước sau để triển khai mã của bạn vào Dịch vụ lưu trữ Firebase:
- Đảm bảo rằng dòng lệnh của bạn đang truy cập thư mục
performance-monitoring-startcủa ứng dụng. - Triển khai các tệp của bạn vào dự án Firebase bằng cách chạy lệnh sau:
firebase deploy
- Bảng điều khiển sẽ hiển thị như sau:
=== 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
- Truy cập ứng dụng web hiện được lưu trữ đầy đủ bằng Lưu trữ Firebase tại hai trong số các miền phụ Firebase của riêng bạn:
https://<projectId>.firebaseapp.comvàhttps://<projectId>.web.app.
Xác minh rằng giám sát hiệu suất được kích hoạt
Mở bảng điều khiển Firebase và chuyển đến tab Hiệu suất . Nếu bạn thấy thông báo chào mừng hiển thị "Đã phát hiện SDK", thì bạn đã tích hợp thành công với Giám sát hiệu suất Firebase!
Gửi tin nhắn hình ảnh
Tạo một số dữ liệu hiệu suất bằng cách gửi hình ảnh trong ứng dụng trò chuyện của bạn.
- Sau khi đăng nhập vào ứng dụng trò chuyện của bạn, hãy nhấp vào nút tải lên hình ảnh
. - Chọn một tệp hình ảnh bằng bộ chọn tệp.
- Hãy thử gửi nhiều hình ảnh (một vài mẫu được lưu trữ trong
public/images/) để bạn có thể kiểm tra việc phân phối các chỉ số tùy chỉnh và thuộc tính tùy chỉnh.
Tin nhắn mới sẽ hiển thị trong giao diện người dùng của ứng dụng cùng với hình ảnh bạn đã chọn.
11. Giám sát bảng điều khiển
Sau khi triển khai ứng dụng web của bạn và gửi thông báo hình ảnh với tư cách là người dùng, bạn có thể xem lại dữ liệu hiệu suất trong bảng điều khiển giám sát hiệu suất (trong bảng điều khiển Firebase).
Truy cập trang tổng quan của bạn
- Trong bảng điều khiển Firebase , hãy chọn dự án có ứng dụng
Friendly Chatcủa bạn. - Trong bảng điều khiển bên trái, tìm phần Chất lượng và nhấp vào Hiệu suất .
Xem lại dữ liệu trên thiết bị
Sau khi giám sát hiệu suất đã xử lý dữ liệu ứng dụng của bạn, bạn sẽ thấy các tab dọc theo đầu trang tổng quan. Đảm bảo kiểm tra lại sau nếu bạn chưa thấy bất kỳ dữ liệu hoặc tab nào.
- Nhấp vào tab Trên thiết bị .
- Bảng tải trang hiển thị các chỉ số hiệu suất khác nhau mà tính năng giám sát hiệu suất tự động thu thập trong khi trang của bạn đang tải.
- Bảng Thời lượng hiển thị mọi dấu vết tùy chỉnh mà bạn đã xác định trong mã ứng dụng của mình.
- Nhấp vào saveImageMessage trong bảng Thời lượng để xem xét các số liệu cụ thể cho quá trình theo dõi.
- Nhấp vào Tổng hợp để xem lại sự phân bổ kích thước hình ảnh. Bạn có thể xem số liệu bạn đã thêm để đo kích thước hình ảnh cho dấu vết tùy chỉnh này.
- Nhấp vào Theo thời gian bên cạnh Tổng hợp trong bước trước. Bạn cũng có thể xem Thời lượng của dấu vết tùy chỉnh. Nhấp vào Xem thêm để xem lại dữ liệu đã thu thập chi tiết hơn.
- Trong trang mở ra, bạn có thể phân đoạn dữ liệu thời lượng theo loại MIME hình ảnh bằng cách nhấp vào imageType . Dữ liệu cụ thể này đã được ghi lại do thuộc tính imageType mà bạn đã thêm vào dấu vết tùy chỉnh của mình.
Xem lại dữ liệu mạng
Yêu cầu mạng HTTP/S là một báo cáo nắm bắt thời gian phản hồi và kích thước tải trọng của các cuộc gọi mạng.
- Quay lại màn hình chính của bảng điều khiển theo dõi hiệu suất.
- Nhấp vào tab Mạng để xem danh sách các mục yêu cầu mạng cho ứng dụng web của bạn.
- Duyệt qua chúng để xác định các yêu cầu chậm và bắt đầu khắc phục sự cố để cải thiện hiệu suất ứng dụng của bạn!
12. Xin chúc mừng!
Bạn đã bật SDK Firebase để theo dõi hiệu suất và thu thập dấu vết tự động cũng như dấu vết tùy chỉnh để đo lường hiệu suất trong thế giới thực của ứng dụng trò chuyện của bạn!
Những gì chúng tôi đã bảo hiểm:
- Thêm SDK giám sát hiệu suất Firebase vào ứng dụng web của bạn.
- Thêm dấu vết tùy chỉnh vào mã của bạn.
- Ghi lại số liệu tùy chỉnh gắn với dấu vết tùy chỉnh.
- Phân đoạn dữ liệu hiệu suất bằng các thuộc tính tùy chỉnh.
- Hiểu cách sử dụng bảng điều khiển giám sát hiệu suất để hiểu rõ hơn về hiệu suất ứng dụng của bạn.