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


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

  • Tự động nhận nhật ký chuỗi liên kết 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 được thu thập Crashlytics trong ứng dụng.

  • Tắt tính năng báo cáo sự cố tự động và bật tính năng chọn tham gia báo cáo 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.

Báo cáo trường hợp ngoại lệ

Báo cáo các trường hợp ngoại lệ đã phát hiện

Nếu có các trường hợp ngoại lệ dự kiến, bạn có thể yêu cầu SDK Crashlytics báo cáo các trường hợp đó dưới dạng sự kiện không nghiêm trọng. Những sự kiện này được ghi lại trên thiết bị, sau đó được gửi cùng với báo cáo sự kiện quan trọng tiếp theo hoặc khi người dùng cuối khởi động lại trò chơi.

Bạn có thể ghi lại các ngoại lệ trong C# bằng phương thức sau:

Crashlytics.LogException(Exception ex);

Bạn có thể ghi lại các ngoại lệ dự kiến trong các khối try/catch của trò chơi:

try {
    myMethodThatThrows();
} catch (Exception e) {
   Crashlytics.LogException(e);
   // handle your exception here!
}

Báo cáo các trường hợp ngoại lệ chưa nắm bắt được

Đối với các ngoại lệ chưa phát hiện được không làm hỏng trò chơi của bạn (ví dụ: các ngoại lệ C# chưa phát hiện được trong logic trò chơi), bạn có thể yêu cầu SDK Crashlytics báo cáo các ngoại lệ đó dưới dạng sự kiện nghiêm trọng bằng cách đặt thuộc tính Crashlytics.ReportUncaughtExceptionsAsFatal thành true, trong đó bạn khởi chạy Crashlytics trong dự án Unity. Các sự kiện này được báo cáo cho Crashlytics theo thời gian thực mà người dùng cuối không cần khởi động lại trò chơi.

Khi bạn báo cáo các trường hợp ngoại lệ chưa nắm bắt này là sự kiện nghiêm trọng, chúng sẽ được tính vào số liệu thống kê về người dùng không gặp sự cố và cảnh báo tốc độ.

Xin lưu ý rằng sự cố gốc luôn được báo cáo là sự kiện nghiêm trọng. Các sự kiện này được ghi lại trên thiết bị rồi gửi đi khi người dùng cuối khởi động lại trò chơi.

void Start() {
    // Since there is no try-block surrounding this call, if an exception is thrown,
    // it is considered unexpected.
    // Setting `Crashlytics.ReportUncaughtExceptionsAsFatal = true`
    // will ensure that such cases are reported as fatals.
    thirdPartyMethodThatMayThrow();
}

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

Đối với các ứng dụng Android sử dụng IL2CPP, 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 việc hỏng bộ nhớ trong ứng dụng, đây là nguyên nhân chính gây ra các lỗ hổng bảo mật của ứ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 Crashlytics.

  • Bạn cũng có thể dùng bộ lọc và tín hiệu "Báo cáo GWP-ASan" mới để xem nhanh tất cả vấn đề về dữ liệu này.

Bạn có thể nhận được báo cáo bộ nhớ GWP-ASan nếu ứng dụng của bạn sử dụng SDK Crashlytics mới nhất cho Unity (phiên bản 10.7.0 trở lên) và đã bật GWP-ASan một cách rõ ràng (yêu cầu bạn sửa đổi Tệp kê khai ứng dụng Android). Nếu có mã C++ trong ứng dụng, 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 Android.

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 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ẻ con Khoá) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Lọc ở đầu trang).

Khi được gọi nhiều lần, các giá trị mới cho các khoá hiện có sẽ cập nhật giá trị này và chỉ giá trị mới nhất được thu thập khi ghi lại sự cố.

Crashlytics.SetCustomKey(string key, string value);

Thêm thông điệp nhật ký tuỳ chỉnh

Thông báo đã ghi nhật ký được liên kết với dữ liệu về sự cố của bạn và xuất hiện trong trang tổng quan của Firebase Crashlytics khi bạn xem một sự cố cụ thể.

Crashlytics.Log(string message);

Đặt giá trị nhận dạng người dùng

Bạn có thể sử dụng số nhận dạng, mã thông báo hoặc giá trị băm để xác định duy nhất người dùng cuối của ứng dụng mà không tiết lộ hoặc truyền bất kỳ thông tin cá nhân nào của họ. Bạn cũng có thể xoá giá trị bằng cách đặt giá trị đó thành một chuỗi trống. Giá trị này được hiển thị trong trang tổng quan Firebase Crashlytics khi xem một sự cố cụ thể.

Crashlytics.SetUserId(string identifier);

Nhận nhật ký breadcrumb

Nhật ký đường dẫn 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 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ể giúp ích khi bạn cố gắng tái hiện và gỡ lỗi sự cố.

Nhật ký breadcrumb (tập hợp liên kết phân cấp) do Google Analytics cung cấp. Vì vậy, để nhận nhật ký breadcrumb (tập hợp liên kết phân cấp), bạn cần bật Google Analytics cho dự án Firebase và thêm Firebase SDK cho Google Analytics vào ứng dụng của mình. Sau khi đáp ứng các yêu cầu này, nhật ký breadcrumb (tập hợp liên kết phân cấp) sẽ tự động được đưa vào dữ liệu của sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về một vấn đề.

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

Nhật ký chuỗi liên kế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 thao tác 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 cả dữ liệu điền sẵn nhật ký đường dẫn.

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. Bạn có thể 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ằng cách cho phép họ chọn nhận báo cáo sự cố.

Để tắt tính năng thu thập tự động và chỉ khởi chạy Crashlytics cho một số người dùng, hãy gọi tính năng ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn sẽ 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 tự động báo cáo sự cố, hãy chuyển false dưới dạng 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.

Crashlytics.IsCrashlyticsCollectionEnabled = true

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 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ó phải là một phần của xu hướng lớn hơn hay không. Đối với nhiều vấn đề, tính năng 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ố.

Tính năng 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 tính năng 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 đề Crashlytics trong bảng điều khiển Firebase.