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

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


Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và 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à các trường hợp liên quan đến các sự kiện được báo cáo cho Crashlytics.

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

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

Nếu có các trường hợp ngoại lệ dự kiến, bạn có thể yêu cầu Crashlytics SDK báo cáo các trường hợp 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 trong nhật ký trên thiết bị, 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 trường hợp 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 trường hợp 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 bắt được

Đối với các trường hợp ngoại lệ chưa bắt được không khiến trò chơi của bạn gặp sự cố (ví dụ: các trường hợp ngoại lệ C# chưa bắt được trong logic trò chơi), bạn có thể yêu cầu Crashlytics SDK báo cáo các trường hợp 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 khi 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à không cần người dùng cuố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 bắt được này dưới dạng sự kiện nghiêm trọng có nghĩa là các trường hợp ngoại lệ đó 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 các sự cố gốc luôn được báo cáo dưới dạng sự kiện nghiêm trọng. Các sự kiện này được ghi lại trong nhật ký trên thiết bị, sau đó được gửi cùng với báo cáo sự kiện nghiêm trọng 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();
}

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

  • 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 đề trong Crashlytics trang tổng quan.

  • Bạn cũng 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 ứng dụng của bạn sử dụng Crashlytics SDK 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 (bạn phải sửa đổi Tệp kê khai ứng dụng Android). Nếu có bất kỳ mã C++ nào trong ứng dụng, bạn có thể kiểm thử 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 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 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ẻ 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).

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ị và chỉ giá trị mới nhất được ghi lại khi ghi lại sự cố.

Crashlytics.SetCustomKey(string key, string value);

Thêm thông báo nhật ký tuỳ chỉnh

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

Crashlytics.Log(string message);

Đặt mã 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ý breadcrumb 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ự kiện 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 bạn cố gắng tái tạo và gỡ lỗi một vấn đề.

Nhật ký breadcrumb được cung cấp bởi Google Analytics. Vì vậy, để nhận nhật ký breadcrumb, 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 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 của một vấn đề.

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

Nhật ký breadcrumb 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 hiển thị một loạt hành động của người dùng dẫn đến sự cố, sự kiện 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 dữ liệu, bao gồm cả dữ liệu điền sẵn nhật ký breadcrumb.

Bật tính năng 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 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 mà họ gửi bằng cách cho phép họ chọn tham gia 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 đã chọn, hãy gọi tính năng ghi đè việc thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn tồn tại trên tất cả các lần khởi chạy tiếp theo của ứng dụng để Crashlytics có thể tự động thu thập báo cáo cho người dùng đó.

Crashlytics.IsCrashlyticsCollectionEnabled = true

Nếu sau này 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ẽ được áp dụng vào lần tiếp theo người dùng khởi chạy ứng dụng và sẽ tồn tại trên tất cả các lần khởi chạy tiếp theo cho 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 từ 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 các 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 đề Crashlytics trong Firebase bảng điều khiển.

Các bước tiếp theo