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 theo dõi hiệu suất của ứng dụng. 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 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 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. Đối với ứng dụng Android, bạn cũng có thể theo dõi các phương thức cụ thể bằng cách sử dụng chú thích @AddTrace. Bạn có thể bắt đầu các dấu vết mã tuỳ chỉnh sau khi tạo và các dấu vết này an toàn cho chuỗi.

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 bảng dấu vết, nằm ở 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 sau trên 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 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 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ã ứ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ã 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ự.
• Dấu vết mã tuỳ chỉnh hỗ trợ việc thêm chỉ số tuỳ chỉnh và thuộ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 các dòng mã tương tự như sau (ví dụ này sử dụng tên theo dõi tuỳ chỉnh là test_trace):

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace

myTrace.stop()
MainActivity.kt

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace

myTrace.stop();
MainActivity.java

(Không bắt buộc) Giám sát các phương pháp cụ thể bằng @AddTrace

Các ứng dụng Android cũng hỗ trợ chú thích @AddTrace để đo lường dấu vết mã tuỳ chỉnh. Khi sử dụng tính năng này, dấu vết bắt đầu từ đầu phương thức được chỉ định và dừng khi phương thức hoàn tất, bao gồm mọi nội dung mà phương thức gọi.

Ví dụ: bạn có thể tạo một dấu vết mã tuỳ chỉnh có tên là onCreateTrace. Dấu vết này sẽ chạy khi phương thức onCreate() được gọi.

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
// the `enabled` argument is optional and defaults to true
@AddTrace(name = "onCreateTrace", enabled = true)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}
MainActivity.kt

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}
MainActivity.java

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 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ó 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 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, chẳng hạn như số lượt truy cập và số lượt không truy cập vào bộ nhớ đệm (sử dụng tên sự kiện mẫu là item_cache_hit và item_cache_miss và số tăng là 1).

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace (and log custom metrics)
val item = cache.fetch("item")
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1)
} else {
    myTrace.incrementMetric("item_cache_miss", 1)
}

myTrace.stop()
MainActivity.kt

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace (and log custom metrics)
Item item = cache.fetch("item");
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1);
} else {
    myTrace.incrementMetric("item_cache_miss", 1);
}

myTrace.stop();
MainActivity.java

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 từ khi bắt đầu theo dõi cho đến khi kết thúc.

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

• Tên của 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 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 các thuộc tính tuỳ chỉnh không chứa bất kỳ thông tin nào giúp Google nhận dạng cá nhân.

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

Firebase.performance.newTrace("test_trace").trace {
    // Update scenario.
    putAttribute("experiment", "A")

    // Reading scenario.
    val experimentValue = getAttribute("experiment")

    // Delete scenario.
    removeAttribute("experiment")

    // Read attributes.
    val traceAttributes = this.attributes
}
MainActivity.kt

Trace trace = FirebasePerformance.getInstance().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();
MainActivity.java

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 lỗi hồi quy bằng cách xem các thay đổi qua từng tuần hoặc xác minh rằng những thay đổi gần đây trong mã của bạn đang giúp 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 của bạ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ố cho biết 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 chúng

Để xem dấu vết, hãy chuyển đến trang tổng quan 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 mức thay đổi theo tỷ lệ phần trăm 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 đề 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 chỉ số có liên quan trên trang tổng quan và nhận thấy sự khác biệt 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 sự thay đổi đáng kể về tỷ lệ phần trăm.
• 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 bất kỳ thẻ chỉ số nào, hãy chọn more_vert => Xem chi tiết. Trang khắc phục sự cố sẽ 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 đó.
• Trong cảnh báo qua email, hãy nhấp vào Kiểm 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 Bộ lọcadd để 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
• 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 các 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.

• Xem báo cáo chi tiết về phiên hoạt động của người dùng, trong đó bạn có thể thấy một dấu vết cụ thể trong ngữ cảnh dòng thời gian của các dấu vết khác được thu thập trong cùng một phiên.