Tùy chỉnh báo cáo sự cố Firebase Crashlytics của bạn

Hướng dẫn này mô tả cách tùy chỉnh báo cáo sự cố của bạn bằng SDK Firebase Crashlytics. Theo mặc định, Crashlytics 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 (thay vào đó, bạn có thể tắt báo cáo sự cố tự động và bật báo cáo chọn tham gia cho người dùng của mình). Crashlytics cung cấp bốn cơ chế ghi nhật ký ngay lập tức: khóa tùy chỉnh , nhật ký tùy chỉnh , số nhận dạng người dùngngoại lệ bị phát hiện .

Thêm phím tùy chỉnh

Khóa tùy 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 khóa/giá trị tùy ý với báo cáo sự cố của mình, sau đó sử dụng các khóa tùy chỉnh để tìm kiếm và lọc báo cáo sự cố trong bảng điều khiển Firebase.

  • Trong bảng điều khiển Crashlytics , bạn có thể tìm kiếm các vấn đề khớp với khóa tùy chỉnh.
  • Khi đang xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các khóa tùy chỉnh liên quan cho từng sự kiện ( tab phụ Keys ) và thậm chí lọc các sự kiện theo các khóa tùy chỉnh ( Menu bộ lọc ở đầu trang).

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

Nhanh

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

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

Mục tiêu-C

Khi đặt số nguyên, boolean hoặc số float, hãy đóng 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 khóa hiện có bằng cách gọi khóa đó và đặt nó thành một giá trị khác. Ví dụ:

Nhanh

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

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

Mục tiêu-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 khóa/giá trị bằng cách sử dụng phương thức setCustomKeysAndValues ​​với NSDictionary làm tham số duy nhất:

Nhanh

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)

Mục tiêu-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 tường trình tùy chỉnh

Để cung cấp 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 tùy 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ố của bạn và hiển thị chúng trong trang Crashlytics của bảng điều khiển Firebase , trong tab Nhật ký .

Nhanh

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 kèm theo thông báo, đối tượng mà bạn chuyển tới log() phải tuân theo 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ừ việc gọi getVaList() . Ví dụ:

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

Để biết thêm 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 Crashlytics.

Mục tiêu-C

Sử dụng log hoặc logWithFormat để giúp xác định vấn đề. Lưu ý rằng nếu bạn muốn nhận được kết quả nhật ký hữu ích kèm theo thông báo, đối tượng mà bạn chuyển sang một trong hai phương thức phải ghi đè thuộc tính phiên bản 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 chi tiết về cách sử dụng loglogWithFormat , hãy tham khảo tài liệu tham khảo Crashlytics.

Đặt định danh người dùng

Để chẩn đoán sự cố, việc biết người dùng nào của bạn đã gặp phải sự cố nhất định thường rất hữu ích. Crashlytics bao gồm 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 ID người dùng vào báo cáo của bạn, hãy chỉ định cho mỗi người dùng một mã định danh duy nhất dưới dạng số ID, mã thông báo hoặc giá trị băm:

Nhanh

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

Mục tiêu-C

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

Nếu bạn cần xóa mã định danh người dùng sau khi đặt nó, hãy đặt lại giá trị thành một chuỗi trống. Việc xóa mã định danh người dùng sẽ không xóa các bản ghi Crashlytics hiện có. Nếu bạn cần xóa các bản ghi được liên kết với ID người dùng, hãy liên hệ với bộ phận hỗ trợ của Firebase .

Bật báo cáo chọn tham gia

Theo mặc định, Crashlytics tự động thu thập các báo cáo sự cố cho tất cả người dùng ứng dụng của bạn. Để cung cấp cho người dùng nhiều quyền kiểm soát hơn đối với dữ liệu họ gửi, bạn có thể bật báo cáo chọn tham gia bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu tới Crashlytics khi bạn chọn trong mã của mình:

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

    • Khóa: FirebaseCrashlyticsCollectionEnabled
    • Giá trị: false
  2. Cho phép thu thập cho những người dùng được chọn bằng cách gọi ghi đè thu thập dữ liệu Crashlytics khi chạy. Giá trị ghi đè vẫn tồn tại trong các lần khởi chạy ứng dụng của bạn để Crashlytics có thể tự động thu thập báo cáo.

    Để chọn không tham gia báo cáo sự cố tự động, hãy chuyển false làm giá trị ghi đè. Khi được đặt thành false , giá trị mới không được áp dụng cho đến lần chạy ứng dụng tiếp theo.

    Nhanh

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Mục tiêu-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Quản lý dữ liệu Crash Insights

Crash Insights giúp bạn giải quyết sự cố 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 sự cố 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 đề, 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 xu hướng ổn định chung. Nếu không muốn chia sẻ dữ liệu ứng dụng của mình, bạn có thể chọn không tham gia Crash Insights từ menu Crash Insights ở đầu danh sách sự cố Crashlytics trong bảng điều khiển Firebase .