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

Chọn nền tảng: iOS+ Android Flutter Unity


Bạn có thể nhấp vào một vấn đề và xem báo cáo Sự kiện chi tiết 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ể tuỳ chỉnh các báo cáo đó để hiểu rõ hơn về những gì đang xảy ra trong ứng dụng và các trường hợp liên quan đến sự kiện được báo cáo cho Crashlytics.

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 trước khi xảy ra 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 bảng điều khiển Firebase.

  • Bạn có thể tìm kiếm những 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 liên kết cho từng sự kiện (thẻ con Keys (Khoá)) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Filter (Bộ lọc) ở đầu trang).

Sử dụng phương thức thực thể setCustomKey để đặt 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ố gốc hoặc String. Dưới đây là một số ví dụ:

Kotlin 

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 giá trị khác cho khoá. Ví dụ:

Kotlin 

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

Kotlin

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

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

Kotlin 

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 người dùng nào đã gặp phải một sự cố nhất định. Crashlytics có 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 giá trị 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:

Kotlin 

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ị này 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ã nhận dạng người dùng, hãy liên hệ với nhóm 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ỳ ý thêm 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 lựa chọn này đều được mô tả trên trang này ở phần trên.

crashlytics.h được cung cấp 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 nhận xét trong tệp tiêu đề để biết hướng dẫn về cách sử dụng API NDK C++.

Thêm báo cáo GWP-ASan để gỡ lỗi hỏng bộ nhớ

Crashlytics có thể giúp bạn gỡ lỗi 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 lỗi 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 cho ứng dụng.

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

  • 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 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ả vấn đề liên quan đến 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 bằng mã gốc mẫu trong tài liệu về Android.

Báo cáo 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 chúng 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 ngoại lệ không nghiêm trọng trong khối catch của ứng dụng. Ví dụ:

Kotlin 

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
}

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

Kotlin 

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
}

Java 

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
}

Tất cả các 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 DevOps & Engagement (DevOps và mức độ tương tác) > Crashlytics dashboard (Trang tổng quan về ) của Firebase console (Bảng điều khiển ). 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 nền chuyên dụng để giảm thiểu tác động đến hiệu suất của ứng dụng. Để 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à gửi chúng vào lần tiếp theo ứng dụng khởi chạy.

Lấy nhật ký dấu vết

Nhật ký dấu vết giúp bạn hiểu rõ hơn về các hoạt động tương tác của người dùng với ứng dụng của bạn trước khi xảy ra sự cố, lỗi không nghiêm trọng hoặc lỗi ANR. Các nhật ký này có thể hữu ích khi bạn cố gắng tái hiện và gỡ lỗi một vấn đề.

Nhật ký dấu vết được cung cấp bởi Google Analytics, vì vậy, để nhận nhật ký dấu vết, bạn cần bật Google Analytics cho dự án Firebase của mình và thêm Firebase SDK cho Google Analytics vào ứng dụng. Sau khi đáp ứng các yêu cầu này, nhật ký dấu vết sẽ tự động được đưa vào 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 đề (xem tất cả vấn đề trong trang tổng quan DevOps và Mức độ tương tác > Crashlytics của bảng điều khiển Firebase).

SDK Analytics tự động ghi lại sự kiện screen_view, cho phép nhật ký dấu vết hiển thị danh sách các màn hình đã xem trước khi xảy ra sự kiện lỗi, sự kiện không nghiêm trọng hoặc sự kiện ANR. Nhật ký dấu vết screen_view chứa tham số firebase_screen_class.

Nhật ký dấu vết cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi lại theo cách thủ công trong phiên của người dùng, bao gồm cả dữ liệu tham số của sự kiện. Dữ liệu này có thể giúp cho thấy một loạt hành động của người dùng dẫn đến sự cố, lỗi 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ý dấu vết.

Bật tính năng báo cáo chọn sử dụ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. Để người dùng có thêm quyền kiểm soát đối với dữ liệu họ gửi, bạn có thể bật tính năng báo cáo chọn tham gia 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 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 dữ liệu cho một số người dùng bằng cách gọi cơ chế ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè sẽ duy trì trong tất cả các lần khởi chạy ứng dụng tiếp theo để Crashlytics có thể tự động thu thập báo cáo cho người dùng đó.

    Kotlin 

    Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

    Java 

    FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

    Nếu sau đó người dùng chọn không tham gia thu thập dữ liệu, bạn có thể truyền false làm giá trị ghi đè. Giá trị này sẽ áp dụng vào lần tiếp theo người dùng chạy ứng dụng và sẽ được duy trì trong tất cả các lần chạy tiếp theo của người dùng đó.

Quản lý dữ liệu Thông tin chi tiết về sự cố

Thông tin chi tiết về sự cố 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 của bạn với dấu vết của các ứng dụng Firebase khác và cho bạn biết liệu vấn đề của bạn có nằm trong một xu hướng lớn hơn hay không. Đối với nhiều vấn đề, Thông tin chi tiết về sự cố 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 phổ biến. 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ố trong trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề trong trang tổng quan DevOps và mức độ gắn bó > Crashlytics của bảng điều khiển Firebase.

Các bước tiếp theo