Tuỳ chỉnh báo cáo lỗi 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 đề và nhận 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ề điều gì đang xảy ra trong ứng dụng của bạn và tình huống liên quan đến các sự kiện được báo cáo cho Crashlytics.

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

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

• Tự động lấy nhật ký đường dẫn 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 do Crashlytics thu thập trong ứng dụng của bạn.

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

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 giá trị/khoá 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 của 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).

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 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 thiết lập số nguyên, giá trị boolean hoặc số thực có độ chính xác đơn, hãy đánh dấu vào hộp giá trị là @(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 giá trị/khoá bằng cách sử dụng phương thức setCustomKeysAndValues có thông số duy nhất là NSSchema:

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

Để cung cấp thêm ngữ cảnh cho các sự kiện dẫn đến một 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ị chúng trên 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 64kB và xoá các mục nhập nhật ký cũ khi nhật ký của một phiên vượt quá giới hạn đó.

Swift

Hãy sử dụng log() hoặc log(format:, arguments:) để giúp xác định các vấn đề. Nếu bạn muốn có đầu ra nhật ký hữu ích với thông điệp, thì đối tượng 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)")

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

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

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

Objective-C

Hãy sử dụng log hoặc logWithFormat để giúp xác định các vấn đề. Lưu ý rằng nếu bạn muốn có kết quả nhật ký hữu ích với thông điệp, thì đối tượng mà bạn truyền đến một trong hai phương thức 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 của Crashlytics.

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

Để chẩn đoán một vấn đề, thông thường, bạn nên biết người dùng nào gặp phải một sự cố cụ thể. Crashlytics có một cách để xác định ẩn danh người dùng 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 duy nhất ở dạng mã nhận dạng, 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ột giá trị 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ột mã nhận dạng người dùng, hãy liên hệ với bộ phận hỗ trợ của Firebase.

Lấy nhật ký breadcrumb (tập hợp liên kết phân cấp)

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 trên ứng dụng dẫn đến sự cố, sự kiện không nghiêm trọng hoặc lỗi ANR. Các nhật ký này có thể hữu ích khi cố gắng tái hiện và gỡ lỗi một vấn đề.

Nhật ký breadcrumb do Google Analytics cung cấp. Do đó, để lấy nhật ký breadcrumb, 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 của mình. Sau khi đáp ứng những yêu cầu này, nhật ký breadcrumb sẽ tự động được đi kèm với dữ liệu của sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về vấn đề.

SDK Analytics tự động ghi lại sự kiện screen_view, cho phép nhật ký đường dẫn hiển thị danh sách các màn hình được xem trước khi xảy ra sự cố, sự kiện không nghiêm trọng hoặc lỗi 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 tự ghi lại trong phiên hoạt động của người dùng, bao gồm cả dữ liệu thông 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 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ý breadcrumb (tập hợp liên kết phân cấp).

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 của bạn. Để mang lại cho người dùng thêm quyền kiểm soát đối với dữ liệu mà họ gửi, bạn có thể bật tính năng chọn sử dụng tính năng báo cáo 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 đưa dữ liệu vào mã của mình:

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

   • Phím: FirebaseCrashlyticsCollectionEnabled
   • Giá trị: false

2. Bật tính năng thu thập cho một số người dùng bằng cách gọi chế độ ghi đè hoạt động thu thập dữ liệu của Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn 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 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 ứng dụng tiếp theo.

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Lưu ý: Khi tính năng thu thập dữ liệu bị tắt, Crashlytics sẽ lưu trữ thông tin về sự cố trên thiết bị. Nếu sau đó bạn bật tính năng thu thập dữ liệu, thì mọi thông tin về sự cố được lưu trữ trên thiết bị sẽ được gửi cho Crashlytics để xử lý.

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

Crash Insights 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 từ các ứng dụng Firebase khác, đồng thời cho bạn biết liệu vấn đề của bạn có thuộc một xu hướng lớn hơn hay không. Đối với nhiều vấn đề, Crash Insights thậm chí còn cung cấp tài nguyên để giúp bạn gỡ lỗi sự cố đó.

Crash Insights 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 Crash Insights trên trình đơn Crash Insights ở đầu danh sách vấn đề trên Crashlytics trong bảng điều khiển của 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.