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

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.

Báo cáo ngoại lệ

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

Nếu có các ngoại lệ dự kiến, 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 không nghiêm trọng. Các sự kiện này được ghi lại trên thiết bị và sau đó được gửi cùng với báo cáo sự kiện nghiêm 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 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 xử lý được

Đối với các ngoại lệ chưa được phát hiện không làm trò chơi của bạn gặp sự cố (ví dụ: các ngoại lệ C# chưa được phát hiện 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 tại nơi bạn khởi chạy Crashlytics trong dự án Unity. Những 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 phải khởi động lại trò chơi.

Việc báo cáo các trường hợp ngoại lệ chưa được phát hiện này dưới dạng sự kiện nghiêm trọng có nghĩa là các trường hợp này 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 về tốc độ.

Xin lưu ý rằng trục trặc mã 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 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 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 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 lỗ hổng bảo mật trong ứ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 ứ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 rõ ràng GWP-ASan (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 mã gốc mẫu trong tài liệu về 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 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).

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

Crashlytics.SetCustomKey(string key, string value);

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

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 để nhận dạng duy nhất người dùng cuối của ứng dụng mà không cần 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 xuất hiện khi bạn xem một sự cố cụ thể trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase.

Crashlytics.SetUserId(string identifier);

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. Bạn có thể cho phép người dùng kiểm soát nhiều hơn đối với dữ liệu họ gửi bằng cách cho phép họ chọn báo cáo sự cố.

Để chỉ tắt tính năng thu thập tự động cho những người dùng được chọn, hãy gọi lệnh ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn tồn tại 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 đó.

Crashlytics.IsCrashlyticsCollectionEnabled = 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