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 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 giám sát hiệu suất cung cấp. Đối với ứng dụng Android, bạn cũng có thể theo dõi các phương pháp cụ thể bằng cách sử dụng Chú thích @AddTrace. Bạn có thể bắt đầu theo dõi mã tuỳ chỉnh bất cứ lúc nào sau khi chúng được tạo 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 chúng đôi khi đượ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

Đối với dấu vết mã tùy chỉnh, tính năng Giám sát hiệu suất tự động ghi lại 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 của Firebase. Bạn cũng có thể thêm và theo dõi 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 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 tùy chỉnh và chỉ số tùy chỉnh 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 tính năng Giám sát hiệu suất 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.
  • Có thể chạy nhiều dấu vết mã tuỳ chỉnh cùng 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ó phần đầu hoặc khoảng trắng ở 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ỉnhthuộ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 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 của test_trace):

Kotlin+KTX

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

Java

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

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

Ứng dụng Android cũng hỗ trợ @AddTrace chú giải để đo lường các 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ừ bắt đầu phương thức được chỉ định và dừng khi phương thức hoàn tất, bao gồm bất kỳ thứ gì được phương thức gọi ra.

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

Kotlin+KTX

// 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)
}

Java

// 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);
}

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

Sử dụng tính năng Giám sát hiệu suất 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ố mặc định chỉ số Thời lượng).

Để thêm chỉ số tuỳ chỉnh, hãy thêm một dòng mã tương tự như sau mỗi lần thêm 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, chẳng hạn như lượt truy cập bộ nhớ đệm và các lần bỏ lỡ (ví dụ về tên sự kiện item_cache_hititem_cache_miss cùng một tăng dần 1).

Kotlin+KTX

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

Java

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

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

Sử dụng tính năng Giám sát hiệu suất Trace API để 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 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ó không gian
    • Độ 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_.
  • 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

Kotlin+KTX

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
}

Java

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

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

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 số lần hồi quy bằng cách xem theo từng tuần các thay đổi 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.

hình ảnh bảng chỉ số trong trang tổng quan của tính năng Giám sát hiệu suất Firebase

Để 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 về Hiệu suất trong bảng điều khiển của 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 chuột trên thẻ chỉ số được điền sẵn để có thêm tùy chọn, chẳng hạn như để thay thế hoặc loại bỏ một 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 chúng

Để 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 của Firebase, hãy di chuyển xuống bảng dấu vết, sau đó nhấp vào tab 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ể.

Tính năng 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 của Firebase, trong đó nêu bật chỉ số giúp bạn dễ dàng giải quyết 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 thông báo 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 => 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 về các chỉ số mối quan tâm. Nhấp vào Nút Lọc để lọc dữ liệu theo thuộc tính, ví dụ:

hình ảnh dữ liệu của tính năng Giám sát hiệu suất Firebase được lọc theo thuộc tính
  • 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 đây 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 quốc gia cụ thể vùng

Tìm hiểu thêm về xem dữ liệu cho dấu vết.

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 của Firebase.

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

  • Xem báo cáo chi tiết về phiên 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 phiên hoạt động.