Tuỳ chỉnh báo cáo sự cố cho Android

Bạn có thể nhấp vào một vấn đề và xem báo cáo chi tiết về sự kiện trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của Firebase bảng điều khiển. Bạn có thể tuỳ chỉnh các báo cáo đó để giúp bạn hiểu rõ hơn về 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.

• Gắn mã theo dõi ứng dụng để ghi lại 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 các trường hợp ngoại lệ cho Crashlytics.

• Tự động nhận nhật ký breadcrumb nếu ứng dụng của bạn sử dụng SDK Firebase cho Google Analytics. Các nhật ký này giúp bạn nắm được khả năng hiển thị 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 của bạn.

• Tắt tính năng báo cáo sự cố tự động và bật tính năng báo cáo 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 nắm đượ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 trang tổng quan DevOps và mức độ tương tác > Crashlytics của Firebase bảng điều khiển.

• 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ị. Xin lưu ý rằng setCustomKey được nạp chồng cho tham số value để chấp nhận mọi đối số nguyên thuỷ hoặc String. Dưới đây là một số ví dụ:

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
}

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ụ:

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Thêm hàng loạt cặp khoá-giá trị bằng cách truyền một thực thể của CustomKeysAndValues vào phương thức thực thể setCustomKeys:

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)
}

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 báo nhật ký tuỳ chỉnh

Để có thêm bối cảnh cho các sự kiện dẫn đến 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 các nhật ký với dữ liệu sự cố và hiển thị các nhật ký đó trong thẻ Nhật ký khi bạn xem thông tin chi tiết về một vấn đề (xem tất cả vấn đề của bạn trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase).

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

Firebase.crashlytics.log("message")

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

Đặt mã nhận dạng người dùng

Để chẩn đoán một vấn đề, bạn thường nên biết người dùng nào gặp phải một sự cố nhất định. Crashlytics bao gồm một cách để xác định người dùng ẩn danh 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 mã nhận dạng riêng biệt dưới dạng số nhận dạng, mã thông báo hoặc giá trị đã băm:

Firebase.crashlytics.setUserId("user123456789")

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Nếu bạn cần xoá mã nhận dạng người dùng sau khi đặt mã đó, hãy đặt lại giá trị thành một chuỗi trống. Việc xoá mã 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 được liên kết với một mã nhận dạng người 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 đều được mô tả ở trên trang này.

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 Firebase cho Android.

Đọ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.

Đưa báo cáo GWP-ASan vào để 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. Các 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.

Trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase, bạn có thể thực hiện những việc sau với dữ liệu này:

• Bạn có thể xem dữ liệu này trong thẻ mới "Dấu vết ngăn xếp bộ nhớ" khi nhấp vào thông tin chi tiết của một vấn đề.

• Bạn 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 đề có 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 và sử dụng Crashlytics SDK cho NDK v18.3.6+ (Firebase BoM v31.3.0+). Bạn có thể kiểm thử chế độ thiết lập GWP-ASan bằng cách sử dụng mã gốc mẫu trong tài liệu về 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 các 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 các trường hợp đó cho bạn vào lần tiếp theo ứng dụng của bạn 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ụ:

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Ngoài ra, bạn cũng có thể đính kèm các khoá tuỳ chỉnh vào trường hợp ngoại lệ không nghiêm trọng cụ thể. Ví dụ:

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e) {
        key("string key", "string value")
        key("boolean key", true)
        key("float key", Float.MAX_VALUE)
    }
    // handle your exception here
}

try {
    methodThatThrows();
} catch (Exception e) {
    CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
            .putString("string key", "string value")
            .putBoolean("boolean key", true)
            .putFloat("float key", Float.MAX_VALUE)
            .build();
    FirebaseCrashlytics.getInstance().recordException(e, keysAndValues);
    // handle your exception here
}