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ý: khóa tùy chỉnh, nhật ký tùy chỉnh , số nhận dạng người dùngcác trường hợp ngoại lệ đã bắt .

Thêm khóa tùy chỉnh

Các khóa tùy chỉnh giúp bạn có đượ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 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 trang tổng quan Crashlytics , bạn có thể tìm kiếm các vấn đề khớp với khóa tùy chỉnh.
  • Khi bạn đang xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các phím tùy chỉnh được liên kết cho từng sự kiện (tab phụ Phím ) và thậm chí lọc các sự kiện theo các phím tùy chỉnh (menu Bộ lọc ở đầu trang).

Sử dụng phương thức setCustomValue để đặt các 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")

Objective-C

Khi đặt số nguyên, boolean hoặc float, hãy chọn 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")

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

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 báo nhật ký tùy chỉnh

Để có thêm ngữ cảnh cho 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 các 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 các vấn đề. Nếu bạn muốn nhận được đầu ra nhật ký hữu ích với các thông báo, đối tượng mà bạn chuyển vào 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ề khi 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.

Objective-C

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 nhận được đầu ra nhật ký hữu ích với các thông báo, thì đối tượng mà bạn chuyển cho một trong hai phương thức phải ghi đè thuộc tính 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 chi tiết về cách sử dụng loglogWithFormat , hãy tham khảo tài liệu tham khảo Crashlytics.

Đặt số nhận dạng người dùng

Để chẩn đoán sự cố, thường hữu ích khi biết người dùng nào của bạn gặp phải sự cố nhất định. 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 giá trị nhận dạng duy nhất ở dạng số ID, mã thông báo hoặc giá trị băm:

Nhanh

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

Objective-C

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

Nếu bạn cần xóa số nhận dạng người dùng sau khi đặt, hãy đặt lại giá trị thành chuỗi trống. Xóa số nhận dạng người dùng 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áo cáo các trường hợp ngoại lệ không gây tử vong

Ngoài việc tự động báo cáo sự cố ứng dụng của bạn, Crashlytics cho phép bạn ghi lại các trường hợp ngoại lệ không nghiêm trọng và gửi chúng cho bạn vào lần tiếp theo ứng dụng của bạn khởi chạy.

Bạn có thể ghi lại các trường hợp ngoại lệ không nghiêm trọng bằng cách ghi lại các đối tượng NSError với phương thức recordError . recordError nắm bắt ngăn xếp cuộc gọi của luồng bằng cách gọi [NSThread callStackReturnAddresses] .

Nhanh

Crashlytics.crashlytics().record(error: error)

Objective-C

[[FIRCrashlytics crashlytics] recordError:error];

Khi sử dụng phương thức recordError , điều quan trọng là phải hiểu cấu trúc NSError và cách Crashlytics sử dụng dữ liệu để nhóm các sự cố. Việc sử dụng sai phương thức recordError có thể gây ra hành vi không thể đoán trước và có thể khiến Crashlytics hạn chế báo cáo các lỗi đã ghi cho ứng dụng của bạn.

Một đối tượng NSError có ba đối số:

  • domain: String
  • code: Int
  • userInfo: [AnyHashable : Any]? = nil

Không giống như các sự cố nghiêm trọng, được nhóm lại thông qua phân tích theo dõi ngăn xếp, các lỗi đã ghi được nhóm theo domaincode . Đây là sự khác biệt quan trọng giữa sự cố nghiêm trọng và lỗi đã ghi. Ví dụ:

Nhanh

let userInfo = [
  NSLocalizedDescriptionKey: NSLocalizedString("The request failed.", comment: ""),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString("The response returned a 404.", comment: ""),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString("Does this page exist?", comment: ""),
  "ProductID": "123456",
  "View": "MainView"
]

let error = NSError.init(domain: NSCocoaErrorDomain,
                         code: -1001,
                         userInfo: userInfo)

Objective-C

NSDictionary *userInfo = @{
  NSLocalizedDescriptionKey: NSLocalizedString(@"The request failed.", nil),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString(@"The response returned a 404.", nil),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString(@"Does this page exist?", nil),
  @"ProductID": @"123456",
  @"View": @"MainView",
};

NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain
                                     code:-1001
                                 userInfo:userInfo];

Khi bạn ghi lại lỗi ở trên, nó sẽ tạo ra một vấn đề mới được nhóm bởi NSSomeErrorDomain-1001 . Các lỗi đã ghi bổ sung sử dụng cùng một miền và các giá trị mã được nhóm lại trong cùng một vấn đề. Dữ liệu chứa trong đối tượng userInfo được chuyển đổi thành các cặp khóa-giá trị và được hiển thị trong phần khóa / nhật ký trong một vấn đề riêng lẻ.

Nhật ký và khóa tùy chỉnh

Cũng giống như báo cáo sự cố, bạn có thể nhúng nhật ký và khóa tùy chỉnh để thêm ngữ cảnh vào NSError . Tuy nhiên, có sự khác biệt về những bản ghi được đính kèm với sự cố so với những lỗi đã ghi. Khi sự cố xảy ra và ứng dụng được khởi chạy lại, nhật ký mà Crashlytics truy xuất từ ​​đĩa là những nhật ký được ghi ngay đến thời điểm xảy ra sự cố. Khi bạn đăng nhập một NSError , ứng dụng sẽ không kết thúc ngay lập tức. Vì Crashlytics chỉ gửi báo cáo lỗi đã ghi vào lần khởi chạy ứng dụng tiếp theo và phải giới hạn dung lượng được phân bổ cho các nhật ký trên đĩa, nên có thể ghi đủ sau khi NSError được ghi lại để tất cả nhật ký liên quan được xoay vòng theo thời gian Crashlytics gửi báo cáo từ thiết bị. Hãy ghi nhớ sự cân bằng này khi ghi nhật ký NSErrors và sử dụng nhật ký và khóa tùy chỉnh trong ứng dụng của bạn.

Cân nhắc về hiệu suất

Hãy nhớ rằng việc ghi lại một NSError có thể khá tốn kém. Tại thời điểm bạn thực hiện cuộc gọi, Crashlytics nắm bắt ngăn xếp cuộc gọi của luồng hiện tại bằng cách sử dụng một quy trình được gọi là giải nén ngăn xếp. Quá trình này có thể chuyên sâu về CPU và I / O, đặc biệt là trên các kiến ​​trúc hỗ trợ giải nén DWARF (arm64 và x86). Sau khi hoàn tất việc thư giãn, thông tin được ghi vào đĩa một cách đồng bộ. Điều này ngăn ngừa mất dữ liệu nếu dòng tiếp theo bị lỗi.

Mặc dù gọi API này trên một chuỗi nền là an toàn, nhưng hãy nhớ rằng việc gửi lệnh gọi này đến hàng đợi khác sẽ làm mất ngữ cảnh của dấu vết ngăn xếp hiện tại.

Điều gì về NSExceptions?

Crashlytics không cung cấp phương tiện để ghi và ghi trực tiếp các phiên bản NSException . Nói chung, các API Cocoa và Cocoa Touch không phải là ngoại lệ an toàn. Điều đó có nghĩa là việc sử dụng @catch có thể gây ra các tác dụng phụ ngoài ý muốn rất nghiêm trọng trong quá trình của bạn, ngay cả khi sử dụng hết sức cẩn thận. Bạn không bao giờ nên sử dụng câu @catch trong mã của mình. Vui lòng tham khảo tài liệu của Apple về chủ đề này.

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

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. Để 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 tính năng 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 đến Crashlytics khi bạn chọn trong mã của mình:

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

    • Chìa khóa: FirebaseCrashlyticsCollectionEnabled
    • Giá trị: false
  2. Bật 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 trong thời gian chạy. Giá trị ghi đè vẫn tồn tại qua các lần khởi chạy ứng dụng của bạn nê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 sẽ không áp dụng cho đến lần chạy ứng dụng tiếp theo.

    Nhanh

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Objective-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

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

Crash Insights giúp bạn giải quyết các vấn đề bằng cách so sánh các dấu vết ngăn xếp ẩn danh của bạn với các 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.

Crash Insights 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 ứ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 .