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


Trong trang tổng quan của Crashlytics, bạn có thể nhấp vào một vấn đề để xem thông tin chi tiết báo cáo 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 diễn ra trong ứng dụng và hoàn cảnh xung quanh 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 Firebase SDK 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 đượ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 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).

Sử dụng phương thức thực thể setCustomKey để đặt cặp khoá/giá trị. Lưu ý rằng setCustomKey bị quá tải đối với tham số value không thể chấp nhận bất kỳ dữ liệu gốc nào hoặc đối số 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 một khoá hiện có bằng cách gọi khoá và chế độ cài đặt 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 thực thể của CustomKeysAndValues đến 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 bối cảnh về những sự kiện dẫn đến tai nạn, bạn có thể thêm nhật ký Crashlytics tuỳ chỉnh vào ứng dụng của bạn. Crashlytics liên kết các nhật ký cùng với dữ liệu sự cố của bạn và hiển thị chúng trong trang Crashlytics của Bảng điều khiển 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 một vấn đề, bạn nên biết được người dùng nào đã gặp phải vấn đề một sự cố cụ thể. Crashlytics có cách nhận dạng ẩn danh người dùng trong báo cáo sự cố của bạn.

Để thêm mã nhận dạng người dùng vào báo cáo của bạn, hãy chỉ định cho mỗi người dùng một giá trị nhận dạng duy nhất trong dạng số 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á 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á một giá trị nhận dạng người dùng sẽ không xoá giá trị nhận dạng hiện có Crashlytics bản ghi. Trường hợp bạn cần xoá các bản ghi được liên kết với một người dùng Mã nhận 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, mã nhận dạng người dùng. Tất cả các lựa chọn này được mô tả trên trang bên 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 SDK Android Firebase.

Đọ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++ 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 các 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 hỏng bộ nhớ trong ứng dụng của bạn, đây là nguyên nhân hàng đầu gây ra vấn đề bảo mật ứng dụng lỗ hổng bảo mật.

  • Bạn có thể xem dữ liệu này trong "Dấu vết ngăn xếp bộ nhớ" mới khi bạn nhấp vào vào thông tin chi tiết về vấn đề trong Trang tổng quan của 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 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 bạn và 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 Ví dụ về mã gốc trong tài liệu về 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 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.

Dùng phương thức recordException để ghi lại các trường hợp ngoại lệ không nghiêm trọng trong catch khối. 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 đều xuất hiện dưới dạng 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 ngoại lệ trên một luồng chuyên dụng ở 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 số lượng mạng mà người dùng sử dụng lưu lượng truy cập, Crashlytics nhóm các ngoại lệ đã ghi lại cùng nhau và gửi cho chúng vào lần tiếp theo khi khởi chạy ứng dụng.

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

Nhật ký đường dẫn giúp bạn hiểu rõ hơn về các hoạt độ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 cố gắng tái tạo 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ự cố, sự cố 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ý 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 hiển thị hành động 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 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 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 mà họ gửi, bạn có thể bật chọn tham gia báo cáo bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu cho Crashlytics khi bạn chọn trong mã của mình:

  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 trên 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 báo cáo sự cố tự động, hãy truyền false làm giá trị ghi đè. Khi được đặt thành false, giá trị mới sẽ không áp dụng cho đến lần chạy tiếp theo của ứng dụng.

    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ố

Crash Insights giúp bạn giải quyết vấn đề bằng cách so sánh ngăn xếp ẩn danh dấu vết từ các ứng dụng Firebase khác và cho bạn biết vấn đề của một xu hướng lớn hơn. Đố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ố.

Crash Insights sử dụng dữ liệu tổng hợp về sự cố để 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 Crash Insights từ trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề của Crashlytics trong bảng điều khiển của Firebase.