Tuỳ chỉnh báo cáo lỗi trong Firebase Crashlytics

Trên trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và nhận báo cáo sự kiện chi tiết. Bạn có thể tuỳ chỉnh các báo cáo đó để hiểu rõ hơn những gì đang xảy ra trong ứng dụng của mình và các trường hợp xảy ra liên quan đến các sự kiện được báo cáo cho Crashlytics.

  • Tự động nhận nhật ký đường dẫn nếu ứng dụng của bạn sử dụng SDK Firebase cho Google Analytics. Các nhật ký này giúp bạn xem được những hành động của người dùng dẫn đến một sự kiện do Crashlytics thu thập trong ứng dụng của bạn.

  • Tắt tính năng tự động báo cáo sự cố và bật tính năng chọn sử dụng để báo cáo cho người dùng. Xin lưu ý rằng theo mặc định, Crashlytics tự động thu thập báo cáo sự cố cho tất cả người dùng ứng dụng của bạn.

Thêm khoá tuỳ chỉnh

Khoá tuỳ chỉnh giúp bạn biết được trạng thái cụ thể của ứng dụng dẫn đến sự cố. Bạn có thể liên kết các cặp khoá/giá trị tuỳ ý với báo cáo sự cố, sau đó sử dụng các khoá tuỳ chỉnh để tìm kiếm và lọc báo cáo sự cố trong bảng điều khiển của Firebase.

  • Trong trang tổng quan Crashlytics, bạn có thể tìm kiếm các vấn đề khớp với một khoá tuỳ chỉnh.

  • Khi xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các khoá tuỳ chỉnh liên kết cho từng sự kiện (thẻ con Khoá) và thậm chí là lọc sự kiện theo các khoá tuỳ chỉnh (trình đơn Bộ lọc ở đầu trang).

Sử dụng phương thức thực thể setCustomKey để đặt cặp khoá/giá trị. Hãy lưu ý rằng setCustomKey bị quá tải để tham số value chấp nhận bất kỳ đối số nguyên gốc hoặc String nào. Sau đây là một số ví dụ:

Kotlin+KTX 

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("my_string_key", "foo") // String value
    key("my_bool_key", true) // boolean value
    key("my_double_key", 1.0) // double value
    key("my_float_key", 1.0f) // float value
    key("my_int_key", 1) // int value
}

Java 

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("my_string_key", "foo" /* string value */);

crashlytics.setCustomKey("my_bool_key", true /* boolean value */);

crashlytics.setCustomKey("my_double_key", 1.0 /* double value */);

crashlytics.setCustomKey("my_float_key", 1.0f /* float value */);

crashlytics.setCustomKey("my_int_key", 1 /* int value */);

Bạn cũng có thể sửa đổi giá trị của khoá hiện có bằng cách gọi khoá và đặt khoá đó thành một giá trị khác. Ví dụ:

Kotlin+KTX 

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

Java 

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Thêm hàng loạt cặp giá trị/khoá bằng cách truyền một thực thể của CustomKeysAndValues vào phương thức thực thể setCustomKeys:

Kotlin+KTX

Đối với Kotlin, chức năng hiện có này đơn giản hơn so với việc sử dụng trình tạo CustomKeysAndValues.

crashlytics.setCustomKeys {
  key("str_key", "hello")
  key("bool_key", true)
  key("int_key", 1)
  key("long_key", 1L)
  key("float_key", 1.0f)
  key("double_key", 1.0)
}

Java 

CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
.putString("string key", "string value")
.putString("string key 2", "string  value 2")
.putBoolean("boolean key", True)
.putBoolean("boolean key 2", False)
.putFloat("float key", 1.01)
.putFloat("float key 2", 2.02)
.build();

FirebaseCrashlytics.getInstance().setCustomKeys(keysAndValues);

Thêm thông điệp nhật ký tuỳ chỉnh

Để tự tìm hiểu thêm về các sự kiện dẫn đến sự cố, bạn có thể thêm nhật ký Crashlytics tuỳ chỉnh vào ứng dụng của mình. Crashlytics liên kết nhật ký với dữ liệu về sự cố và hiển thị các nhật ký đó trên trang Crashlytics của bảng điều khiển của Firebase, trong thẻ Nhật ký.

Sử dụng log để giúp xác định sự cố. Ví dụ:

Kotlin+KTX 

Firebase.crashlytics.log("message")

Java 

FirebaseCrashlytics.getInstance().log("message");

Đặt giá trị nhận dạng người dùng

Để chẩn đoán sự cố, bạn nên biết được người dùng nào đã gặp phải một sự cố cụ thể. Crashlytics có một cách để xác định ẩn danh người dùng trong báo cáo sự cố.

Để thêm mã nhận dạng người dùng vào báo cáo, hãy chỉ định cho mỗi người dùng một giá trị nhận dạng duy nhất dưới dạng số mã nhận dạng, mã thông báo hoặc giá trị đã băm:

Kotlin+KTX 

Firebase.crashlytics.setUserId("user123456789")

Java 

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Nếu bạn cần xoá giá trị nhận dạng người dùng sau khi đặt, hãy đặt lại giá trị đó thành một chuỗi trống. Việc xoá giá trị nhận dạng người dùng sẽ không xoá các bản ghi Crashlytics hiện có. Nếu bạn cần xoá các bản ghi liên kết với một mã nhận dạng người dùng, hãy liên hệ với nhóm hỗ trợ Firebase.

(Chỉ dành cho Android NDK) Thêm siêu dữ liệu vào báo cáo sự cố NDK

Bạn có thể tuỳ ý đưa tiêu đề crashlytics.h vào mã C++ để thêm siêu dữ liệu vào báo cáo sự cố NDK, chẳng hạn như khoá tuỳ chỉnh, nhật ký tuỳ chỉnh, giá trị nhận dạng người dùng. Tất cả các tuỳ chọn này được mô tả trên trang này ở trên.

crashlytics.h có sẵn dưới dạng thư viện C++ chỉ có tiêu đề trong Kho lưu trữ GitHub của Firebase Android SDK.

Đọc các nhận xét trong tệp tiêu đề để biết hướng dẫn về cách sử dụng API C++ của NDK.

Bao gồm các báo cáo GWP-ASan để gỡ lỗi các sự cố hỏng bộ nhớ

Crashlytics có thể giúp bạn gỡ lỗi các sự cố do lỗi bộ nhớ gốc gây ra bằng cách thu thập các báo cáo GWP-ASan. Những lỗi liên quan đến bộ nhớ này có thể liên quan đến tình trạng hỏng bộ nhớ trong ứng dụng của bạn. Đây là nguyên nhân chính gây ra các lỗ hổng bảo mật ứng dụng.

  • Bạn có thể xem dữ liệu này trong thẻ "Dấu vết ngăn xếp bộ nhớ" mới khi nhấp vào thông tin chi tiết về vấn đề trong trang tổng quan Crashlytics.

  • Bạn cũng có thể dùng bộ lọc và tín hiệu "Báo cáo GWP-ASan" mới để xem nhanh tất cả vấn đề về dữ liệu này.

Bạn có thể nhận báo cáo bộ nhớ GWP-ASan nếu bạn bật GWP-ASan một cách rõ ràng trong ứng dụng của mình và sử dụng Crashlytics SDK cho NDK phiên bản 18.3.6 trở lên (Firebase BoM phiên bản 31.3.0 trở lên). Bạn có thể kiểm thử cách thiết lập GWP-ASan bằng cách sử dụng mã gốc mẫu trong tài liệu Android.

Báo cáo các trường hợp ngoại lệ không nghiêm trọng

Ngoài việc tự động báo cáo sự cố của ứng dụng, Crashlytics còn cho phép bạn ghi lại các ngoại lệ không nghiêm trọng và gửi cho bạn vào lần tiếp theo ứng dụng của bạn khởi chạy.

Hãy dùng phương thức recordException để ghi lại các ngoại lệ không nghiêm trọng trong các khối catch của ứng dụng. Ví dụ:

Kotlin+KTX 

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

Java 

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Tất cả trường hợp ngoại lệ đã ghi nhận sẽ xuất hiện dưới dạng vấn đề không nghiêm trọng trong bảng điều khiển của Firebase. Bản tóm tắt vấn đề chứa tất cả thông tin về trạng thái mà bạn thường nhận được từ các sự cố, cùng với thông tin phân tích chi tiết theo phiên bản Android và thiết bị phần cứng.

Crashlytics xử lý các ngoại lệ trên một luồng chuyên biệt ở chế độ nền để giảm thiểu tác động đến hiệu suất đối với ứng dụng của bạn. Để giảm lưu lượng truy cập mạng của người dùng, Crashlytics gộp các trường hợp ngoại lệ đã ghi lại thành từng nhóm và gửi chúng vào lần tiếp theo ứng dụng khởi chạy.

Nhận nhật ký breadcrumb (tập hợp liên kết phân cấp)

Nhật ký Breadcrumb giúp bạn hiểu rõ hơn về những hành động tương tác mà người dùng thực hiện với ứng dụng của bạn dẫn đến sự cố, sự cố không nghiêm trọng hoặc sự kiện ANR. Các nhật ký này có thể hữu ích khi bạn cố gắng tái tạo và gỡ lỗi một vấn đề.

Nhật ký breadcrumb (tập hợp liên kết phân cấp) do Google Analytics cung cấp. Vì vậy, để nhận nhật ký breadcrumb (tập hợp liên kết phân cấp), bạn cần bật Google Analytics cho dự án Firebase và thêm Firebase SDK cho Google Analytics vào ứng dụng của mình. Sau khi đáp ứng các yêu cầu này, nhật ký breadcrumb (tập hợp liên kết phân cấp) sẽ tự động được đưa vào dữ liệu của một sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về một vấn đề.

SDK Analytics tự động ghi lại sự kiện screen_view, cho phép nhật ký breadcrumb (tập hợp liên kết phân cấp) hiển thị danh sách các màn hình đã xem trước sự kiện sự cố, sự kiện không nghiêm trọng hoặc sự kiện ANR. Nhật ký breadcrumb (tập hợp liên kết phân cấp) screen_view chứa tham số firebase_screen_class.

Nhật ký Breadcrumb cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn tự ghi trong phiên hoạt động của người dùng, bao gồm cả dữ liệu thông số của sự kiện. Dữ liệu này có thể giúp hiển thị một loạt hành động của người dùng dẫn đến sự cố, sự kiện không nghiêm trọng hoặc sự kiện ANR.

Xin lưu ý rằng bạn có thể kiểm soát việc thu thập và sử dụng dữ liệu Google Analytics, bao gồm cả dữ liệu điền nhật ký breadcrumb (tập hợp liên kết phân cấp).

Bật báo cáo chọn tham gia

Theo mặc định, Crashlytics tự động thu thập báo cáo sự cố cho tất cả người dùng ứng dụng của bạn. Để mang lại cho người dùng nhiều quyền kiểm soát hơn đối với dữ liệu họ gửi, bạn có thể bật tính năng báo cáo chọn sử dụng bằng cách tắt tính năng báo cáo tự động và chỉ gửi dữ liệu đến Crashlytics khi bạn chọn sử dụng trong mã:

  1. Trong khối application của tệp AndroidManifest.xml, hãy thêm thẻ meta-data để tắt tính năng thu thập tự động:

    <meta-data
    android:name="firebase_crashlytics_collection_enabled"
    android:value="false" />

  2. Bật tính năng thu thập dữ liệu cho một số người dùng bằng cách gọi cơ chế ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn tồn tại trong các lần chạy ứng dụng của bạn để Crashlytics có thể tự động thu thập báo cáo. Để chọn không sử dụng tính năng tự động báo cáo sự cố, hãy chuyển false dưới dạng giá trị ghi đè. Khi bạn đặt thành false, giá trị mới sẽ không áp dụng cho đến lần chạy ứng dụng tiếp theo.

    Kotlin+KTX 

    Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

    Java 

    FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Quản lý dữ liệu Thông tin chi tiết về sự cố

Thông tin chi tiết về sự cố giúp bạn giải quyết vấn đề bằng cách so sánh dấu vết ngăn xếp ẩn danh với dấu vết của các ứng dụng Firebase khác, đồng thời cho bạn biết liệu vấn đề của bạn có nằm trong một xu hướng lớn hơn hay không. Đối với nhiều vấn đề, Crash Insights thậm chí còn cung cấp tài nguyên giúp bạn gỡ lỗi sự cố.

Thông tin chi tiết về sự cố sử dụng dữ liệu sự cố tổng hợp để xác định các xu hướng phổ biến về độ ổn định. Nếu không muốn chia sẻ dữ liệu của ứng dụng, bạn có thể chọn không sử dụng Thông tin chi tiết về sự cố trên trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề Crashlytics trong bảng điều khiển của Firebase.