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

iOS trở lên Android Flutter Unity

Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và nhận 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 những gì đang xảy ra trong ứng dụng của bạn và những tình huống liên quan đến sự kiện được báo cáo cho Crashlytics.

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

• Báo cáo ngoại lệ 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 giúp bạn biết đượ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 của bạn.

• Tắt tính năng tự động báo cáo sự cố và bật báo cáo chọn tham gia cho người dùng của mình. Lưu ý rằng, bằng cách Crashlytics 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.

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 của Firebase.

• Trong trang tổng quan Crashlytics, bạn có thể tìm các vấn đề khớp với khoá tuỳ 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 khoá tuỳ chỉnh được liên kết cho từng sự kiện (thẻ phụ Khoá) và thậm chí lọc sự kiện bằng khoá tuỳ chỉnh (trình đơn Bộ 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, nên các giá trị khác sẽ không được lưu. Mỗi cặp khoá/giá trị có thể tăng thành 1 kB.

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ý với dữ liệu sự cố của bạn và hiển thị chúng trong trang Crashlytics 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 giới hạn nhật ký ở mức 64kB và xoá các mục nhập nhật ký cũ hơn 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 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ó một cách giúp xác định danh tính ẩn danh của 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á 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á 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ó Bản ghi Crashlytics. 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 cho 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 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.

Bao gồm các báo cáo GWP-ASan để gỡ lỗi các 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ớ 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 Crashlytics.

• Bạn cũng có thể sử dụng "Báo cáo GWP-ASan" mới tín hiệu và bộ lọc để xem nhanh tất 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 bạn và sử dụng Crashlytics SDK cho NDK phiên bản 18.3.6+ (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 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 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.

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

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
}

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

Tất cả trường hợp ngoại lệ đã ghi nhận sẽ 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ùng với phân tích 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 số lượng mạng mà người dùng sử dụng lưu lượng truy cập, Crashlytics gộp các lô ngoại lệ được 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ý Breadcrumb giúp bạn hiểu rõ hơn về hoạt động tương tác của người dùng gặp phải 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ý 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 của bạn và thêm Firebase SDK cho Google Analytics cho ứng dụng của bạn. Khi các yêu cầu này được đáp ứng, nhật ký breadcrumb (tập hợp liên kết phân cấp) sẽ tự động kèm theo 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 đề nào đó.

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ý Breadcrumb cũng được điền sẵn bất kỳ sự kiện tùy chỉnh mà bạn tự ghi lại trong phiên hoạt độ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ị 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 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 cho một số người dùng bằng cách gọi dữ liệu trên Crashlytics ghi đè bộ sưu tập trong thời gian chạy. Giá trị ghi đè vẫn tồn tại trong các lần chạy của ứng dụng để Crashlytics có thể tự động thu thập báo cáo. Chọn không sử dụng của báo cáo sự cố tự động, hãy chuyển false dưới dạng giá trị ghi đè. Khi đặt với false, thì 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ữ sự cố cục bộ trên thiết bị. Nếu tính năng thu thập dữ liệu được kích hoạt sau đó, mọi thông tin sự cố lưu trữ trên thiết bị sẽ được gửi đến Crashlytics cho xử lý.

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ố.

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

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