Thêm giám sát tùy chỉnh cho mã ứng dụng cụ thể

Giám sát hiệu suất thu thập dấu vết để giúp bạn theo dõi hiệu suất của ứng dụng. Dấu vết là báo cáo về dữ liệu hiệu suất được ghi lại 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 theo dõi mã tùy chỉnh , bạn có thể đo thời gian ứng dụng của mình hoàn thành một tác vụ cụ thể hoặc một nhóm tác vụ, chẳng hạn như tải một nhóm hình ảnh hoặc truy vấn cơ sở dữ liệu của bạn.

Số liệu mặc định cho theo dõi mã tùy chỉnh là "thời lượng" của nó (thời gian giữa điểm bắt đầu và điểm dừng của theo dõi), nhưng bạn cũng có thể thêm số liệu tùy chỉnh .

Trong mã của mình, bạn xác định phần đầu và phần cuối của một lần theo dõi mã tùy chỉnh bằng cách sử dụng API do SDK giám sát hiệu suất cung cấp.Dấu vết mã tùy chỉnh có thể được bắt đầu bất cứ lúc nào sau khi chúng được tạo và chúng là luồng an toàn.

Vì số liệu 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 tab phụ Dấu vết tùy chỉnh của bảng dấu vết, ở cuối bảng điều khiển Hiệu suất (tìm hiểu thêm về cách sử dụng bảng điều khiển sau trên trang này).

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

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

Thuộc tính tùy chỉnh và chỉ số tùy chỉnh hiển thị trong bảng điều khiển Firebase cùng với thuộc tính mặc định và chỉ số mặc định cho theo dõi.

Thêm dấu vết mã tùy chỉnh

Sử dụng API theo dõi giám sát hiệu suất để thêm dấu vết mã tùy chỉnh nhằm giám sát mã ứng dụng cụ thể.

Lưu ý những điều dưới đây:

• Một ứng dụng có thể có nhiều dấu vết mã tùy chỉnh.
• Nhiều dấu vết mã tùy 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ự 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ợ thêm số liệu tùy chỉnh và thuộc tính tùy chỉnh .

Để bắt đầu và dừng theo dõi mã tùy chỉnh, hãy bọc mã mà bạn muốn theo dõi 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ã tùy chỉnh bằng API thời gian người dùng

Ngoài API theo dõi giám sát hiệu suất, bạn có thể thêm các dấu vết mã tùy chỉnh bằng cách sử dụng API thời gian người dùng gốc của trình duyệt. Thời lượng của một dấu vết được đo bằng API này được SDK giám sát hiệu suất tự động chọn. 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 giám sát hiệu suất không đồng bộ. Sau khi SDK được khởi tạo, SDK sẽ ghi lại các phép đo xảy ra trước khi tải.

Để sử dụng tính năng này, hãy bọc mã bạn muốn theo dõi bằng dấu Thời gian của 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 của trình duyệt.

Khi sử dụng API thời gian của người dùng, không thể thêm thuộc tính và chỉ số tùy chỉnh vào dấu vết mã tùy chỉnh. Sử dụng API theo dõi giám sát hiệu suất nếu bạn muốn thêm các thành phần tùy chỉnh đó vào theo dõi mã tùy chỉnh.

Thêm số liệu tùy chỉnh vào dấu vết mã tùy chỉnh

Sử dụng API theo dõi giám sát hiệu suất để thêm số liệu tùy chỉnh vào dấu vết mã tùy chỉnh.

Lưu ý những điều dưới đây:

• Tên cho chỉ số 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ự gạch dưới ( _ ) ở đầu và độ dài tối đa là 100 ký tự.
• Mỗi lần theo dõi mã tùy chỉnh có thể ghi tối đa 32 chỉ số (bao gồm cả chỉ số Thời lượng mặc định).

Để thêm số liệu tùy 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ố tùy chỉnh này 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 tùy chỉnh cho dấu vết mã tùy chỉnh

Sử dụng API theo dõi giám sát hiệu suất để thêm thuộc tính tùy chỉnh vào dấu vết mã tùy chỉnh.

Để sử dụng thuộc tính tùy chỉnh, hãy thêm mã vào ứng dụng của bạn để xác định thuộc tính và liên kết thuộc tính đó với một dấu vết mã tùy chỉnh cụ thể. Bạn có thể đặt thuộc tính tùy chỉnh bất kỳ lúc nào trong khoảng thời gian từ khi quá trình theo dõi bắt đầu cho đến khi quá trình theo dõi kết thúc.

Lưu ý những điều dưới đây:

• Tên cho các thuộc tính 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ự 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 cho tên là AZ , az và _ .

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

• Vui lòng đảm bảo rằng các thuộc tính tùy chỉnh không chứa bất kỳ thông tin nào nhận dạng cá nhân một cá nhân với Google.

  Tìm hiểu thêm về hướng dẫn 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 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 phiên bản SDK Giám sát hiệu suất tương thích với quá trình 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 thời gian thực .

Theo dõi số liệu cụ thể trong bảng điều khiển của bạn

Để tìm hiểu xem các chỉ số chính của bạn đang có xu hướng như thế nào, hãy thêm chúng vào bảng chỉ số của bạn ở đầu Bảng điều khiển hiệu suất . Bạn có thể nhanh chóng xác định hồi quy bằng cách xem các thay đổi hàng tuần hoặc xác minh rằng những 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ố của bạn, hãy làm theo các bước sau:

1. Chuyển đến bảng điều khiển 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 của bạn.
3. Nhấp vào more_vert trên thẻ chỉ số đã điền để có thêm tùy chọn, chẳng hạn như để thay thế hoặc xóa 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 đồ họa và dưới dạng phần trăm thay đổi bằng số.

Tìm hiểu thêm về cách sử dụng bảng điều khiển .

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

Để xem dấu vết của bạn, hãy chuyển đến Bảng điều khiển hiệu suất trong bảng điều khiển Firebase, cuộn xuống bảng dấu vết, sau đó nhấp vào tab phụ thích hợp. Bảng hiển thị một số chỉ số hàng đầu cho từng 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ể.

Giám sát hiệu suất cung cấp một trang khắc phục sự cố trong bảng điều khiển Firebase làm nổi bật các thay đổi về chỉ số, giúp 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 của bạn. Bạn có thể sử dụng trang khắc phục sự cố khi tìm hiểu về các vấn đề tiềm ẩn về hiệu suất, chẳng hạn như trong các trường hợp sau:

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

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

• Trên bảng điều khiển số liệu, nhấp vào nút Xem chi tiết số liệu .
• Trên bất kỳ thẻ số liệu nào, 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ố bạn đã chọn.
• Trong bảng theo dõi, hãy nhấp vào tên theo dõi hoặc bất kỳ giá trị chỉ số nào trong hàng được liên kết với dấu vết đó.
• Trong một cảnh báo qua email, hãy nhấp vào Điều tra ngay bây giờ .

Khi bạn nhấp vào một tên theo dõi trong bảng theo dõi, khi đó bạn có thể đi sâu vào các số liệu quan tâm. Nhấn nút add bộ lọc để 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 cách kết nối 3g tác động đến ứng dụng của bạn
• 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ề cách xem dữ liệu cho dấu vết của bạn .

Bước tiếp theo

• Tìm hiểu thêm về cách sử dụng 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 mã đang làm giảm hiệu suất của ứng dụng của bạn. 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 lần theo dõi mã tùy chỉnh cụ thể vượt quá ngưỡng mà bạn đã đặt.