Tuỳ chỉnh báo cáo sự cố trong Firebase Crashlytics

iOS+ Android Flutter Unity

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

• Đo lường ứng dụng của bạn để ghi lại khoá tuỳ chỉnh, thông báo nhật ký tuỳ chỉnh và mã nhận dạng người dùng.

• Báo cáo ngoại lệ cho Crashlytics.

• Tự động nhận nhật ký chuỗi liên kết nếu ứng dụng của bạn sử dụng SDK Firebase cho Google Analytics. Các nhật ký này cho bạn biết về các 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.

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

Thêm khoá tuỳ chỉnh

Khoá tuỳ chỉnh giúp bạn biết 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 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 được liên kết cho từng sự kiện (thẻ con Khoá) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Lọc ở đầu trang).

Lưu ý: Crashlytics hỗ trợ tối đa 64 cặp khoá/giá trị. Sau khi bạn đạt ngưỡng này, các giá trị bổ sung sẽ không được lưu. Mỗi cặp khoá/giá trị có thể có kích thước tối đa là 1 kB.

Sử dụng phương thức thực thể setCustomKey để đặt cặp khoá/giá trị. Xin lưu ý rằng setCustomKey được nạp chồng cho tham số value để chấp nhận mọi đối số gốc hoặc String. 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 khoá/giá trị 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 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

Để có thêm ngữ cảnh 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 sự cố và hiển thị các nhật ký này trong trang Crashlytics của bảng điều khiển của Firebase, trong thẻ Nhật ký.

Lưu ý: Để tránh làm chậm ứng dụng, Crashlytics sẽ giới hạn dung lượng nhật ký ở mức 64kB và xoá các mục nhập nhật ký cũ khi nhật ký của một phiên vượt quá giới hạn đó.

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 bao gồm một cách để xác định người dùng ẩn danh 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ố định danh, 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á mã 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ã 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.

Thêm báo cáo GWP-ASan để gỡ lỗi các vấn đề về hỏng bộ nhớ

Crashlytics có thể giúp bạn gỡ lỗi sự cố do lỗi bộ nhớ gốc gây ra bằng cách thu thập 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ề một vấn đề trong trang tổng quan Crashlytics.

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

Bạn có thể nhận được báo cáo bộ nhớ GWP-ASan nếu bật GWP-ASan một cách rõ ràng trong ứng dụng và sử dụng SDK Crashlytics 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ử chế độ thiết lập GWP-ASan bằng mã gốc mẫu trong tài liệu Android.

Báo cáo các 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 trường hợp 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 khởi chạy.

Lưu ý: Crashlytics chỉ lưu trữ 8 trường hợp ngoại lệ được ghi lại gần đây nhất. Nếu ứng dụng của bạn gửi nhiều hơn 8 trường hợp ngoại lệ, thì các trường hợp ngoại lệ cũ sẽ bị mất.

Sử 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
}

Cảnh báo: Nếu bạn muốn đưa một giá trị duy nhất (chẳng hạn như mã nhận dạng người dùng hoặc dấu thời gian) vào thông báo ngoại lệ, hãy sử dụng khoá tuỳ chỉnh thay vì thêm giá trị trực tiếp trong thông báo ngoại lệ. Việc thêm giá trị trực tiếp có thể dẫn đến một số vấn đề và có thể khiến Crashlytics giới hạn báo cáo lỗi trong ứng dụng.

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

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

Nhận nhật ký breadcrumb

Nhật ký đường dẫn giúp bạn hiểu rõ hơn về các lượt 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ể giúp ích khi bạn cố gắng tái hiện và gỡ lỗi sự cố.

Nhật ký chuỗi dẫn đường được cung cấp bởi Google Analytics. Vì vậy, để nhận nhật ký chuỗi dẫn đường, bạn cần bật Google Analytics cho dự án Firebase và thêm SDK Firebase cho Google Analytics vào ứng dụng. Sau khi đáp ứng các yêu cầu này, nhật ký chuỗi dẫn đường 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ý đường dẫn screen_view chứa tham số firebase_screen_class.

Nhật ký chuỗi liên kết cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi lại theo cách thủ công trong phiên của người dùng, bao gồm cả dữ liệu tham số của sự kiện. Dữ liệu này có thể giúp cho thấy một loạt thao tác của người dùng dẫn đến sự cố, sự cố 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 sẵn nhật ký đường dẫn.

Bật tính năng báo cáo chọn sử dụng

Theo mặc định, Crashlytics sẽ tự động thu thập báo cáo sự cố cho tất cả người dùng ứng dụng. Để 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 tính năng ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè sẽ tồn tại trong các lần khởi chạy ứng dụng để 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);

Lưu ý: Khi tính năng thu thập dữ liệu bị tắt, Crashlytics sẽ lưu trữ thông tin về sự cố trên thiết bị. Nếu bạn bật tính năng thu thập dữ liệu sau đó, mọi thông tin sự cố được lưu trữ trên thiết bị sẽ được gửi đến Crashlytics để xử lý.

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 và cho bạn biết liệu vấn đề của bạn có phải là một phần của 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ố.

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

Lưu ý: Khi bạn tắt tính năng chia sẻ dữ liệu, thông tin chi tiết về các vấn đề của bạn cũng sẽ bị xoá. Các thay đổi có thể mất tới 24 giờ mới có hiệu lực.