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


Tính năng 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.

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 liên kết với một mã cụ thể trong ứng dụng. Với dấu vết mã tuỳ chỉnh, bạn có thể đo lường thời gian ứng dụng hoàn thành một tác vụ cụ thể hoặc một nhóm tác vụ, ví dụ: tải một nhóm hình ảnh hoặc truy vấn cơ sở dữ liệu.

Chỉ số mặc định cho 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 dừng của dấu vết), nhưng bạn cũng có thể thêm chỉ số tuỳ chỉnh.

Trong mã, bạn xác định điểm bắt đầu và điểm kết thúc của một dấu vết mã tuỳ chỉnh bằng cách sử dụng các API do SDK theo dõi hiệu suất 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ẻ con Dấu vết tuỳ chỉnh của bảng dấu vết ở cuối trang tổng quan Hiệu suất (tìm hiểu thêm về cách sử dụ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

Đối với dấu vết mã tuỳ chỉnh, tính năng Giám sát hiệu suất sẽ tự động ghi lại các thuộc tính mặc định (siêu dữ liệu phổ biến như phiên bản ứng dụng, quốc gia, thiết bị, v.v.) để bạn có thể lọc dữ liệu cho dấu vết trong bảng điều khiển Firebase. Bạn cũng có thể thêm và theo dõi các thuộc tính tuỳ chỉnh (chẳng hạn như cấp độ trò chơi hoặc thuộc tính người dùng).

Bạn có thể định cấu hình thêm dấu vết mã tuỳ chỉnh để ghi lại các 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 một chỉ số tuỳ chỉnh cho số lần truy cập và không truy cập được vào bộ nhớ đệ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 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 của 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 API theo dõi giám sát hiệu suất để thêm dấu vết mã tuỳ chỉnh nhằm theo dõi mã ứ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 của dấu vết mã tuỳ chỉnh phải đáp ứng các yêu cầu sau: không có dấu cách ở đầu hoặc cuối, không có ký tự dấu gạch dưới (_) ở đầu và có độ dài tối đa là 100 ký tự.
  • Dấu vết mã tuỳ chỉnh hỗ trợ việc thêm chỉ số tuỳ chỉnhthuộc tính tuỳ chỉnh.

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

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

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

Sử dụng API theo dõi hiệu suất để thêm các 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ó dấu cách ở đầ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 đếm các sự kiện liên quan đến hiệu suất xảy ra trong ứng dụng của bạn, chẳng hạn như lượt truy cập vào bộ nhớ đệm hoặc lượt thử lại.

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();

Tạo thuộc tính tuỳ chỉnh cho 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 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ã tuỳ chỉnh cụ thể. Bạn có thể đặt thuộc tính tuỳ chỉnh bất cứ lúc nào trong khoảng thời gian từ khi bắt đầu theo dõi đến khi dừng theo dõi.

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

  • Tên cho các thuộc tính tuỳ chỉnh phải đáp ứng các yêu cầu sau: không có dấu cách ở đầu hoặc cuối, không có ký tự dấu gạch dưới (_) ở đầu và độ dài tối đa là 32 ký tự.

  • 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.

  • Bạn không nên sử dụng các thuộc tính tuỳ chỉnh chứa thông tin nhận dạng cá nhân của một người với Google.

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();

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

Theo dõi các chỉ số cụ thể trong 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 trường hợp hồi quy bằng cách xem các thay đổi theo 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 chuyển đến trang tổng quan về Hiệu suất trong bảng điều khiển Firebase, sau đó nhấp vào thẻ Trang tổng quan. 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. Nhấp vào dấu ba chấm dọc () trên thẻ chỉ số đã điền sẵn để xem các tuỳ chọn khác, chẳng hạn như thay thế hoặc xoá một chỉ số.

Bảng chỉ số cho thấy dữ liệu chỉ số được thu thập theo thời gian, cả ở dạng đồ hoạ và dưới dạng tỷ lệ phần trăm thay đổi theo số liệu.

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, hãy chuyển đến trang tổng quan về Hiệu suất trong bảng điều khiển Firebase, 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à bạn thậm chí có thể sắp xếp danh sách theo tỷ lệ phần trăm thay đổi cho một chỉ số cụ thể.

Nếu nhấp vào tên một dấu vết trong bảng dấu vết, bạn có thể nhấp vào nhiều màn hình để khám phá dấu vết và tìm hiểu chi tiết về các chỉ số mà bạn quan tâm. Trên hầu hết các trang, bạn có thể sử dụng nút Lọc (ở trên cùng bên trái màn hình) để lọc dữ liệu theo thuộc tính, ví dụ:

  • Lọc theo Phiên bản ứng dụng để xem dữ liệu về một bản phát hành trước đó hoặc bản phát hành mới nhất của bạn
  • Lọc theo Thiết bị để tìm hiểu cách các thiết bị cũ xử lý ứ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ác 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 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.