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

iOS+ Android Flutter Unity

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 diễn ra trong ứng dụng và hoàn cảnh xung quanh các sự kiện được báo cáo cho Crashlytics.

• Đo lường ứng dụng của bạn để ghi lại khoá tuỳ chỉnh, thông báo nhật ký tuỳ chỉnh và mã nhận dạng người dùng.

• Báo cáo ngoại lệ 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 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.

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

Thêm khoá tuỳ chỉnh

Khoá tuỳ chỉnh giúp bạn biết 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).

Lưu ý: Crashlytics hỗ trợ tối đa 64 cặp khoá/giá trị. Sau khi bạn đạt đến ngưỡng này, các giá trị bổ sung sẽ không được lưu. Mỗi cặp khoá/giá trị có thể có kích thước tối đa là 1 kB.

Sử dụng phương thức setCustomValue để đặt cặp khoá/giá trị. Ví dụ:

Swift

// Set int_key to 100.
Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set str_key to "hello".
Crashlytics.crashlytics().setCustomValue("hello", forKey: "str_key")

Objective-C

Khi đặt số nguyên, boolean hoặc số thực, hãy đóng gói giá trị dưới dạng @(value).

// Set int_key to 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set str_key to "hello".
[[FIRCrashlytics crashlytics] setCustomValue:@"hello" forKey:@"str_key"];

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

Swift

Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set int_key to 50 from 100.
Crashlytics.crashlytics().setCustomValue(50, forKey: "int_key")

Objective-C

[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set int_key to 50 from 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(50) forKey:@"int_key"];

Thêm hàng loạt cặp khoá/giá trị bằng cách sử dụng phương thức setCustomKeysAndValues với NSDictionary làm tham số duy nhất:

Swift

let keysAndValues = [
                 "string key" : "string value",
                 "string key 2" : "string value 2",
                 "boolean key" : true,
                 "boolean key 2" : false,
                 "float key" : 1.01,
                 "float key 2" : 2.02
                ] as [String : Any]

Crashlytics.crashlytics().setCustomKeysAndValues(keysAndValues)

Objective-C

NSDictionary *keysAndValues =
    @{@"string key" : @"string value",
      @"string key 2" : @"string value 2",
      @"boolean key" : @(YES),
      @"boolean key 2" : @(NO),
      @"float key" : @(1.01),
      @"float key 2" : @(2.02)};

[[FIRCrashlytics crashlytics] setCustomKeysAndValues: 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 các nhật ký Crashlytics tuỳ chỉnh vào ứng dụng. 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 trang Crashlytics của bảng điều khiển Firebase, trong thẻ Nhật ký.

Lưu ý: Để tránh làm chậm ứng dụng, Crashlytics giới hạn nhật ký ở mức 64 kB và xoá các mục nhập nhật ký cũ hơn khi nhật ký của một phiên vượt quá giới hạn đó.

Swift

Sử dụng log() hoặc log(format:, arguments:) để giúp xác định vấn đề. Nếu bạn muốn nhận được kết quả nhật ký hữu ích cùng với thông báo, thì đối tượng mà bạn truyền đến log() phải tuân thủ thuộc tính CustomStringConvertible. log() trả về thuộc tính mô tả mà bạn xác định cho đối tượng. Ví dụ:

Crashlytics.crashlytics().log("Higgs-Boson detected! Bailing out…, \(attributesDict)")

.log(format:, arguments:) định dạng các giá trị được trả về từ lệnh gọi getVaList(). Ví dụ:

Crashlytics.crashlytics().log(format: "%@, %@", arguments: getVaList(["Higgs-Boson detected! Bailing out…", attributesDict]))

Để biết thêm thông tin chi tiết về cách sử dụng log() hoặc log(format:, arguments:), hãy tham khảo tài liệu tham khảo về Crashlytics.

Objective-C

Sử dụng log hoặc logWithFormat để giúp xác định vấn đề. Xin lưu ý rằng nếu bạn muốn nhận được kết quả nhật ký hữu ích cùng với thông báo, thì đối tượng mà bạn truyền vào một trong hai phương thức này phải ghi đè thuộc tính thực thể description. Ví dụ:

[[FIRCrashlytics crashlytics] log:@"Simple string message"];

[[FIRCrashlytics crashlytics] logWithFormat:@"Higgs-Boson detected! Bailing out... %@", attributesDict];

[[FIRCrashlytics crashlytics] logWithFormat:@"Logging a variable argument list %@" arguments:va_list_arg];

Để biết thêm thông tin chi tiết về cách sử dụng log và logWithFormat, hãy tham khảo tài liệu tham khảo về Crashlytics.

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

Để chẩn đoán một vấn đề, bạn thường cầ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ố.

Để 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 duy nhất dưới dạng số định danh, mã thông báo hoặc giá trị băm:

Swift

Crashlytics.crashlytics().setUserID("123456789")

Objective-C

[[FIRCrashlytics crashlytics] setUserID:@"123456789"];

Nếu bạn cần xoá mã nhận dạng người dùng sau khi đặt, hãy đặt lại giá trị 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ợ Firebase.

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ý chuỗi dẫn đường được cung cấp bởi Google Analytics. Vì vậy, để nhận nhật ký chuỗi dẫn đường, bạn cần bật Google Analytics cho dự án Firebase và thêm SDK Firebase cho Google Analytics vào ứng dụng. Sau khi đáp ứng các yêu cầu này, nhật ký chuỗi dẫn đường 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 đề.

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 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. Để người dùng có nhiều quyền kiểm soát hơn đối với dữ liệu mà 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ã:

1. Tắt tính năng thu thập tự động bằng cách thêm khoá mới vào tệp Info.plist:

   • Khoá: FirebaseCrashlyticsCollectionEnabled
   • Giá trị: 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 tính năng ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè sẽ tồn tại trong các lần khởi chạy ứng dụng để Crashlytics có thể tự động thu thập báo cáo.

   Để chọn không sử dụng tính năng báo cáo sự cố tự động, hãy truyền false làm 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.

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Lưu ý: Nếu bạn tắt tính năng báo cáo tự động, hãy lưu ý những điều sau:

• Khi tính năng thu thập dữ liệu bị tắt đối với người dùng, Crashlytics sẽ lưu trữ thông tin sự cố trên thiết bị. Nếu bạn bật tính năng thu thập dữ liệu sau đó, mọi thông tin sự cố được lưu trữ trên thiết bị sẽ được gửi đến Crashlytics để xử lý.
• Khi bạn bật tính năng báo cáo chọn tham gia, hệ thống chỉ có thể thu thập thông tin sự cố từ những người dùng đã chọn tham gia thu thập dữ liệu một cách rõ ràng. Do đó, độ chính xác của các chỉ số không có sự cố (như số người dùng không gặp sự cố và số phiên không gặp sự cố) sẽ bị ảnh hưởng vì Crashlytics chỉ có thông tin về sự cố từ những người dùng đã chọn sử dụng (thay vì tất cả người dùng). Điều này có nghĩa là các chỉ số không gặp sự cố có thể kém tin cậy và phản ánh ít hơn độ ổn định tổng thể của ứng 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 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.

Lưu ý: Khi bạn tắt tính năng chia sẻ dữ liệu, thông tin chi tiết về các vấn đề của bạn cũng sẽ bị xoá. Các thay đổi có thể mất tới 24 giờ mới có hiệu lực.