Tùy chỉnh báo cáo sự cố Firebase Crashlytics của bạn

Trong bảng điều khiển Crashlytics, bạn có thể nhấp vào một sự cố và nhận báo cáo sự kiện chi tiết. Bạn có thể tùy chỉnh các báo cáo đó để giúp bạn 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 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 SDK Firebase cho Google Analytics. Những nhật ký này cung cấp cho bạn khả năng hiển thị các hành động của người dùng dẫn đến sự kiện do Crashlytics thu thập trong ứng dụng của bạn.

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

Thêm phím tùy chỉnh

Khóa tùy 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 khóa/giá trị tùy ý với báo cáo sự cố của mình, sau đó sử dụng các khóa tùy chỉnh để tìm kiếm và lọc báo cáo sự cố trong bảng điều khiển Firebase.

  • Trong bảng điều khiển Crashlytics , bạn có thể tìm kiếm các vấn đề khớp với khóa tùy chỉnh.

  • Khi đang xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các khóa tùy chỉnh liên quan cho từng sự kiện ( tab phụ Keys ) và thậm chí lọc các sự kiện theo các khóa tùy chỉnh ( Menu bộ lọc ở đầu trang).

Sử dụng phương thức phiên bản setCustomKey để đặt các cặp khóa/giá trị. Lưu ý rằng setCustomKey bị quá tải để tham số value chấp nhận bất kỳ đối số nguyên thủy hoặc String . Dưới đâ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 khóa hiện có bằng cách gọi khóa đó và đặt nó 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 khóa/giá trị bằng cách chuyển một phiên bản của CustomKeysAndValues ​​sang phương thức phiên bản setCustomKeys :

Kotlin+KTX

Đối với Kotlin, chức năng hiện tại đơn giản hơn 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 tường trình tùy chỉnh

Để cung cấp thêm thông tin về các sự kiện dẫn đến sự cố, bạn có thể thêm nhật ký Crashlytics tùy 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ố của bạn và hiển thị chúng trong trang Crashlytics của bảng điều khiển Firebase , trong tab Nhật ký .

Sử dụng log để giúp xác định vấn đề. Ví dụ:

Kotlin+KTX

Firebase.crashlytics.log("message")

Java

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

Đặt định danh người dùng

Để chẩn đoán sự cố, việc biết người dùng nào của bạn đã gặp phải sự cố nhất định thường rất hữu ích. Crashlytics bao gồm một cách để xác định ẩn danh người dùng trong báo cáo sự cố của bạn.

Để thêm ID 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 mã định danh duy nhất dưới dạng số ID, 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 xóa mã định danh người dùng sau khi đặt nó, hãy đặt lại giá trị thành một chuỗi trống. Việc xóa mã định danh người dùng sẽ không xóa các bản ghi Crashlytics hiện có. Nếu bạn cần xóa các bản ghi được liên kết với ID người dùng, hãy liên hệ với bộ phận hỗ trợ của 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ể tùy ý đưa tiêu đề crashlytics.h vào mã C++ của mình để thêm siêu dữ liệu vào báo cáo sự cố NDK, chẳng hạn như khóa tùy chỉnh , nhật ký tùy chỉnh , số nhận dạng người dùng . Tất cả các tùy 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 Android SDK của Firebase .

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

Bao gồm các báo cáo GWP-ASan để gỡ lỗi các vấn đề 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 lỗ hổng bảo mật ứng dụng.

  • Bạn có thể xem dữ liệu này trong tab "Dấu vết ngăn xếp bộ nhớ" mới khi bạn nhấp vào chi tiết về sự cố trong bảng điều khiển 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 để xem nhanh tất cả các vấn đề với 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 SDK Crashlytics cho NDK v18.3.6+ (Firebase BoM v31.3.0+). Bạn có thể kiểm tra thiết lập GWP-ASan của mình bằng mã gốc mẫu trong tài liệu Android .

Báo cáo trường hợp ngoại lệ không gây tử vong

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

Sử dụng phương thức recordException để ghi lại các ngoại lệ không nghiêm trọng trong khối catch của ứng dụng của bạn. 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ả các trường hợp ngoại lệ được ghi lại đều xuất hiện dưới dạng sự cố không nghiêm trọng trong bảng điều khiển Firebase. Bản tóm tắt sự cố chứa tất cả thông tin trạng thái bạn thường nhận được từ các sự cố, cùng với thông tin chi tiết về 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 nền chuyên dụng để 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 sẽ gộp các trường hợp ngoại lệ đã ghi lại với nhau và gửi chúng vào lần khởi chạy ứng dụng tiếp theo.

Nhận nhật ký đường dẫn

Nhật ký Breadcrumb giúp bạn hiểu rõ hơn về các 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ự kiện không gây tử vong hoặc ANR. Những nhật ký này có thể hữu ích khi cố gắng tái tạo và gỡ lỗi một sự cố.

Nhật ký đường dẫn được cung cấp bởi Google Analytics, do đó, để có được nhật ký đường dẫn, 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 của mình. Sau khi đáp ứng các yêu cầu này, nhật ký đường dẫn sẽ tự động được đưa vào dữ liệu của sự kiện trong tab Nhật ký khi bạn xem chi tiết về sự cố.

SDK Analytics tự động ghi lại sự kiện screen_view để cho phép nhật ký đường dẫn hiển thị danh sách các màn hình được xem trước sự cố, sự kiện không gây tử vong hoặc ANR. Nhật ký breadcrumb screen_view chứa tham số firebase_screen_class .

Nhật ký Breadcrumb cũng được điền với bất kỳ sự kiện tùy chỉnh nào mà bạn đăng nhập theo cách thủ công trong phiên 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 gây tử vong hoặc ANR.

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 vào nhật ký đường dẫn.

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

Theo mặc định, Crashlytics tự động thu thập các báo cáo sự cố cho tất cả người dùng ứng dụng của bạn. Để cung cấp 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 báo cáo chọn tham gia bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu tới 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. Cho phép thu thập cho những người dùng được chọn bằng cách gọi ghi đè thu thập dữ liệu Crashlytics khi chạy. Giá trị ghi đè vẫn tồn tại trong các lần khởi 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 tham gia báo cáo sự cố tự động, hãy chuyển false làm giá trị ghi đè. Khi được đặt thành false , giá trị mới không được á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 Crash Insights

Crash Insights giúp bạn giải quyết sự cố bằng cách so sánh dấu vết ngăn xếp ẩn danh của bạn với dấu vết từ các ứng dụng Firebase khác và cho bạn biết liệu sự cố 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ố.

Crash Insights sử dụng dữ liệu sự cố tổng hợp để xác định xu hướng ổn định chung. Nếu không muốn chia sẻ dữ liệu ứng dụng của mình, bạn có thể chọn không tham gia Crash Insights từ menu Crash Insights ở đầu danh sách sự cố Crashlytics trong bảng điều khiển Firebase .