Thêm hoạt động giám sát tuỳ chỉnh cho mã ứng dụng cụ thể

Performance Monitoring thu thập dấu vết để giúp bạn giám sát hiệu suất của ứng dụng. Đáp Dấu vết là một báo cáo về dữ liệu hiệu suất được thu thập giữa hai thời điểm trong ứng dụng của bạn.

Bạn có thể tạo dấu vết của riêng mình để theo dõi dữ liệu hiệu suất được liên kết với mã cụ thể trong ứng dụng của bạn. Với tính năng dấu vết mã tuỳ chỉnh, bạn có thể đo lường thời gian cần để ứng dụng của bạn hoàn thành một tác vụ cụ thể hoặc một nhóm tác vụ, cho ví dụ về cách tải một tập hợp hình ảnh hoặc truy vấn cơ sở dữ liệu của bạn.

Chỉ số mặc định cho một dấu vết mã tuỳ chỉnh là "thời lượng" (thời gian giữa điểm bắt đầu và điểm kết thúc của dấu vết), nhưng bạn có thể thêm chỉ số tuỳ chỉnh.

Trong mã, bạn xác định điểm bắt đầu và kết thúc của dấu vết mã tuỳ chỉnh bằng cách sử dụng các API do SDK Performance Monitoring cung cấp. Bạn có thể bắt đầu dấu vết mã tuỳ chỉnh bất cứ lúc nào sau khi tạo và các dấu vết này là an toàn cho luồng.

Vì chỉ số mặc định được thu thập cho các dấu vết này là "thời lượng", nên đôi khi chúng được gọi là "Dấu vết thời lượng".

Bạn có thể xem dữ liệu từ các dấu vết này trong thẻ phụ Dấu vết tùy chỉnh của các dấu vết này nằm ở cuối trang tổng quan Hiệu suất (tìm hiểu thêm về bằng bảng điều khiển ở phần sau của trang này).

Thuộc tính mặc định, thuộc tính tuỳ chỉnh và chỉ số tuỳ chỉnh

Bạn có thể định cấu hình thêm tính năng theo dõi mã tuỳ chỉnh để ghi chỉ số tuỳ 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 dấu vết. Ví dụ: bạn có thể tạo chỉ số tuỳ chỉnh cho số lượt truy cập bộ nhớ đệm và số lần bỏ lỡ hoặc số lần giao diện người dùng trở thành không phản hồi trong một khoảng thời gian đáng kể.

Các thuộc tính tuỳ chỉnh và chỉ số tuỳ chỉnh sẽ hiển thị trong bảng điều khiển Firebase cùng với các thuộc tính mặc định và chỉ số mặc định cho dấu vết.

Thêm dấu vết mã tuỳ chỉnh

Sử dụng Performance Monitoring Trace API để thêm dấu vết mã tuỳ chỉnh nhằm theo dõi mã xử lý ứng dụng cụ thể.

Lưu ý những điều sau:

• Một ứng dụng có thể có nhiều dấu vết mã tuỳ chỉnh.
• Nhiều dấu vết mã tuỳ chỉnh có thể chạy cùng một lúc.
• Tên cho dấu vết mã tùy chỉnh phải đáp ứng các yêu cầu sau: không có khoảng trắng ở đầu hoặc ở cuối, không có ký tự dấu gạch dưới ở đầu (_), và độ dài tối đa là 100 ký tự.
• Dấu vết mã tùy chỉnh hỗ trợ việc thêm chỉ số tùy chỉnh và thuộc tính tuỳ chỉnh.

Để bắt đầu và dừng một dấu vết mã tuỳ chỉnh, hãy gói đoạn mã bạn muốn dấu vết bằng các dòng mã tương tự như sau:

import { trace } from "firebase/performance";

const t = trace(perf, "CUSTOM_TRACE_NAME");
t.start();

// Code that you want to trace 
// ...

t.stop();
perf_add_custom_trace.js

const trace = perf.trace("CUSTOM_TRACE_NAME");
trace.start();

// Code that you want to trace 
// ...

trace.stop();
index.js

Thêm dấu vết mã tuỳ chỉnh bằng cách sử dụng API Thời gian người dùng

Ngoài Performance Monitoring Trace API, bạn có thể thêm dấu vết mã tuỳ chỉnh bằng cách sử dụng gốc của trình duyệt API Thời gian người dùng. Thời lượng của một dấu vết được đo bằng API này sẽ tự động được SDK Performance Monitoring thu thập. Việc sử dụng API Thời gian người dùng đặc biệt hữu ích nếu bạn muốn để tải SDK Performance Monitoring một cách không đồng bộ. Sau khi khởi chạy SDK, SDK sẽ ghi lại các phép đo đã xảy ra trước tải.

Để sử dụng tính năng này, hãy gói mã bạn muốn theo dõi bằng các dấu Thời gian người dùng:

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
perf_user_timing_marks.js

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
index.js

Lưu ý rằng performance trong ví dụ trên đề cập đến Đối tượng window.performance.

Khi sử dụng API Thời gian người dùng, bạn không thể thêm chỉ số và thuộc tính tùy chỉnh vào các dấu vết mã tuỳ chỉnh. Sử dụng Performance Monitoring Trace API nếu bạn muốn thêm những với một dấu vết mã tuỳ chỉnh.

Thêm chỉ số tuỳ chỉnh vào dấu vết mã tuỳ chỉnh

Sử dụng Performance Monitoring Trace API để thêm chỉ số tuỳ chỉnh vào dấu vết mã tuỳ chỉnh.

Lưu ý những điều sau:

• Tên cho chỉ số tuỳ chỉnh phải đáp ứng các yêu cầu sau: không có khoảng trắng ở đầu hoặc ở cuối, không có ký tự dấu gạch dưới ở đầu (_), và độ dài tối đa là 100 ký tự.
• Mỗi dấu vết mã tuỳ chỉnh có thể ghi lại tối đa 32 chỉ số (bao gồm cả chỉ số Thời lượng mặc định).

Để thêm một chỉ số tuỳ chỉnh, hãy thêm một dòng mã tương tự như sau mỗi khi sự kiện xảy ra. Ví dụ: chỉ số tuỳ chỉnh này được tính các sự kiện liên quan đến hiệu suất xảy ra trong ứng dụng của bạn.

import { trace } from "firebase/performance";

async function getInventory(inventoryIds) {
  const t = trace(perf, "inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  t.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  t.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  t.stop();

  return inventoryData;
}
perf_add_custom_metrics.js

async function getInventory(inventoryIds) {
  const trace = perf.trace("inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  trace.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  trace.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  trace.stop();

  return inventoryData;
}
index.js

Tạo thuộc tính tuỳ chỉnh cho dấu vết mã tuỳ chỉnh

Sử dụng Performance Monitoring Trace API để thêm các thuộc tính tuỳ chỉnh vào dấu vết mã tuỳ chỉnh.

Để sử dụng thuộc tính tuỳ chỉnh, hãy thêm mã vào ứng dụng để xác định thuộc tính và liên kết nó với một dấu vết mã tuỳ chỉnh cụ thể. Bạn có thể đặt bất cứ lúc nào từ khi bắt đầu dấu vết cho đến khi dừng dấu vết.

Lưu ý những điều sau:

• Tên cho thuộc tính tuỳ chỉnh phải đáp ứng các yêu cầu sau:

  • Không có khoảng trắng ở đầu hoặc ở cuối, không có ký tự dấu gạch dưới ở đầu (_)
  • Không có khoảng trắng
  • Độ dài tối đa là 32 ký tự
  • Các ký tự được phép sử dụng cho tên là A-Z, a-z và _.

• Mỗi dấu vết mã tuỳ chỉnh có thể ghi lại tối đa 5 thuộc tính tuỳ chỉnh.

• Vui lòng đảm bảo rằng thuộc tính tuỳ chỉnh không chứa bất kỳ thông tin nào xác định danh tính của một cá nhân với Google.

  Tìm hiểu thêm về nguyên tắc này

import { trace } from "firebase/performance";

const t = trace(perf, "test_trace");
t.putAttribute("experiment", "A");

// Update scenario
t.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = t.getAttribute("experiment");

// Delete scenario
t.removeAttribute("experiment");

// Read attributes
const traceAttributes = t.getAttributes();
perf_add_custom_attributes.js

const trace = perf.trace("test_trace");
trace.putAttribute("experiment", "A");

// Update scenario
trace.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = trace.getAttribute("experiment");

// Delete scenario
trace.removeAttribute("experiment");

// Read attributes
const traceAttributes = trace.getAttributes();
index.js

Theo dõi, xem và lọc dữ liệu hiệu suất

Để xem dữ liệu về hiệu suất theo thời gian thực, hãy đảm bảo rằng ứng dụng của bạn sử dụng một biểu đồ Hiệu suất Giám sát phiên bản SDK tương thích với hoạt động xử lý dữ liệu theo thời gian thực. Tìm hiểu thêm về dữ liệu hiệu suất theo thời gian thực.

Theo dõi các chỉ số cụ thể trên trang tổng quan

Để tìm hiểu xu hướng của các chỉ số chính, hãy thêm các chỉ số đó vào bảng chỉ số ở đầu trang tổng quan Hiệu suất. Bạn có thể nhanh chóng xác định các lần hồi quy bằng cách xem các thay đổi giữa các tuần hoặc xác minh rằng các thay đổi gần đây trong mã của bạn đang cải thiện hiệu suất.

Để thêm một chỉ số vào bảng chỉ số, hãy làm theo các bước sau:

1. Chuyển đến trang tổng quan Hiệu suất trong bảng điều khiển Firebase.
2. Nhấp vào một thẻ chỉ số trống, sau đó chọn một chỉ số hiện có để thêm vào bảng điều khiển.
3. Nhấp vào biểu tượng more_vert trên thẻ chỉ số đã điền sẵn để xem thêm các tuỳ chọn, chẳng hạn như thay thế hoặc xoá chỉ số.

Bảng chỉ số hiển thị dữ liệu chỉ số được thu thập theo thời gian, cả ở dạng biểu đồ và dưới dạng phần trăm thay đổi về số.

Tìm hiểu thêm về cách sử dụng trang tổng quan.

Xem dấu vết và dữ liệu của dấu vết

Để xem dấu vết của bạn, hãy chuyển đến Trang tổng quan về Hiệu suất trong bảng điều khiển Firebase, hãy di chuyển xuống bảng dấu vết, sau đó nhấp vào thẻ phụ thích hợp. Bảng này hiển thị một số chỉ số hàng đầu cho mỗi dấu vết và thậm chí bạn có thể sắp xếp danh sách theo phần trăm thay đổi cho một chỉ số cụ thể.

Performance Monitoring cung cấp một trang khắc phục sự cố trong bảng điều khiển Firebase, nêu bật các thay đổi về chỉ số, giúp bạn dễ dàng giải quyết nhanh chóng và giảm thiểu tác động của các vấn đề về hiệu suất đối với ứng dụng và người dùng. Bạn có thể sử dụng trang khắc phục sự cố khi tìm hiểu về các vấn đề về hiệu suất trong các trường hợp sau:

• Bạn chọn các chỉ số có liên quan trên trang tổng quan và nhận thấy có sự chênh lệch lớn.
• Trong bảng dấu vết, bạn sắp xếp để hiển thị các delta lớn nhất ở trên cùng và bạn sẽ thấy một tỷ lệ phần trăm thay đổi đáng kể.
• Bạn nhận được email cảnh báo về vấn đề về hiệu suất.

Bạn có thể truy cập vào trang khắc phục sự cố theo các cách sau:

• Trên trang tổng quan về chỉ số, hãy nhấp vào nút Xem chi tiết về chỉ số.
• Trên thẻ chỉ số bất kỳ, hãy chọn more_vert => Xem chi tiết. Trang khắc phục sự cố hiển thị thông tin về chỉ số mà bạn đã chọn.
• Trong bảng dấu vết, hãy nhấp vào tên dấu vết hoặc bất kỳ giá trị chỉ số nào trong hàng liên kết với dấu vết đó dấu vết.
• Trong thông báo qua email, hãy nhấp vào Điều tra ngay.

Khi nhấp vào tên dấu vết trong bảng dấu vết, bạn có thể xem chi tiết các chỉ số mà bạn quan tâm. Nhấp vào Nút Lọcadd để lọc dữ liệu theo thuộc tính, ví dụ:

• Lọc theo URL trang để xem dữ liệu cho một trang cụ thể trên trang web của bạn
• Lọc theo Loại kết nối hiệu quả để tìm hiểu xem kết nối 3g ảnh hưởng như thế nào đến bạn ứng dụng
• Lọc theo Quốc gia để đảm bảo vị trí cơ sở dữ liệu của bạn không ảnh hưởng đến một khu vực cụ thể

Tìm hiểu thêm về xem dữ liệu cho dấu vết của bạn.

Các bước tiếp theo

• Tìm hiểu thêm về bằng các thuộc tính để kiểm tra dữ liệu hiệu suất.

• Tìm hiểu thêm về cách theo dõi các vấn đề về hiệu suất trong bảng điều khiển Firebase.

• Thiết lập cảnh báo cho các thay đổi về mã đang làm giảm hiệu suất của ứng dụng. Ví dụ: bạn có thể định cấu hình cảnh báo qua email cho nhóm của mình nếu thời lượng của một dấu vết mã tuỳ chỉnh cụ thể vượt quá ngưỡng mà bạn đặt.