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

Trong 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 về điều gì đang xảy ra trong ứng dụng của bạn và tình huống liên quan đến các sự kiện được báo cáo cho Crashlytics.

  • Tự động lấy 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 cho bạn biết 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 báo cáo sự cố chọn tham gia 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 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 giá trị/khoá 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 được liên kết cho từng sự kiện (thẻ phụ Khoá) và thậm chí lọc các sự kiện theo 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ác cặp khoá/giá trị. Lưu ý rằng setCustomKey bị quá tải để tham số value chấp nhận mọi đối số nguyên 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 một 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 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

Để cung cấp thêm ngữ cảnh cho các sự kiện dẫn đến một 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ị chúng trên 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 các vấn đề. 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 đề, thông thường, bạn nên biết 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ố của bạn.

Để 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ạng 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á một 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 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ể 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 một thư viện C++ chỉ dành cho tiêu đề trong Kho lưu trữ GitHub Android SDK.

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

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 khắc phục sự cố do lỗi bộ nhớ gốc 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 hàng đầu 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 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 để 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ậ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 của mình 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 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.

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. 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 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 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 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 lưu lượng truy cập mạng của người dùng, Crashlytics sẽ nhóm các trường hợp ngoại lệ đã ghi lại với nhau và gửi chúng vào lần tiếp theo ứng dụng khởi chạy.

Lấy 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ề các lượt tương tác mà người dùng thực hiện trên ứng dụng dẫn đến sự cố, sự kiện không nghiêm trọng hoặc lỗi ANR. Các nhật ký này có thể hữu ích khi cố gắng tái hiện và gỡ lỗi một vấn đề.

Nhật ký breadcrumb do Google Analytics cung cấp. Do đó, để lấy nhật ký breadcrumb, 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 những yêu cầu này, nhật ký breadcrumb sẽ tự động được đi kèm với dữ liệu của sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về vấn đề.

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 khi xảy ra sự cố, sự kiện không nghiêm trọng hoặc lỗi ANR. Nhật ký breadcrumb 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 lại 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 lỗi 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ý 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 của bạn. Để mang lại cho người dùng thêm quyền kiểm soát đối với dữ liệu mà họ gửi, bạn có thể bật tính năng chọn sử dụng tính năng báo cáo 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 đưa dữ liệu vào 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 cho một số người dùng bằng cách gọi chế độ ghi đè hoạt động thu thập dữ liệu của 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 để 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 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ố

Crash Insights 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 từ 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ó thuộc 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ố đó.

Crash Insights 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 Crash Insights trên trình đơn Crash Insights ở đầu danh sách vấn đề trên Crashlytics trong bảng điều khiển của Firebase.