Catch up on highlights from Firebase at Google I/O 2023. Learn more

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

Hướng dẫn này mô tả cách tùy chỉnh các báo cáo sự cố của bạn bằng SDK Firebase Crashlytics. 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 (thay vào đó, bạn có thể 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 mình). Crashlytics cung cấp bốn cơ chế ghi nhật ký ngay lập tức: khóa tùy chỉnh , nhật ký tùy chỉnh , số nhận dạng người dùng và ngoại lệ đã bắt được .

Thêm khóa 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 các 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 cá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 sự cố khớp với khóa tùy chỉnh.

  • Khi đang xem xét một sự cố cụ thể trong bảng điều khiển, bạn có thể xem các khóa tùy chỉnh được liên kết cho từng sự kiện ( tab phụ Khóa ) 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 đối tượng 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ố Chuỗi 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 một 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 phiên bản CustomKeysAndValues ​​sang phương pháp phiên bản 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ý tùy chỉnh

Để cung cấp thêm ngữ cảnh cho 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 số nhận dạng 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ố cụ thể 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 số nhận dạng duy nhất ở 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, hãy đặt lại giá trị thành chuỗi trống. Xóa mã định danh người dùng không xóa các bản ghi Crashlytics hiện có. Nếu bạn cần xóa 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ỉ 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 của SDK Android 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 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ớ riêng gây ra bằng cách thu thập các báo cáo GWP-ASan. Các lỗi liên quan đến bộ nhớ này có thể liên quan đến lỗi 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 nhấp vào chi tiết của 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 để nhanh chóng xem 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 rõ ràng GWP-ASan 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 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 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 chúng cho bạn vào lần khởi chạy tiếp theo của ứng dụng.

Sử 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 các 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 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 về trạng thái mà bạn thường nhận được từ các sự cố, cùng với các sự cố 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 đố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 nhóm các 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.

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. Để 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 của bạn, hãy thêm thẻ meta-data để tắt bộ sưu tập tự động:

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

  2. Kích hoạt tính năng thu thập cho những người dùng được chọn bằng cách gọi tính năng 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 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 Crash Insights

Thông tin chi tiết về sự cố 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 sự cố, 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 ổn định chung. Nếu không muốn chia sẻ dữ liệu của ứng dụng, bạn có thể chọn không tham gia Thông tin chi tiết về sự cố từ menu Thông tin chi tiết về sự cố ở đầu danh sách sự cố Crashlytics trong bảng điều khiển Firebase .