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

Trong bảng điều khiển Crashlytics, bạn có thể nhấp vào một sự cố và nhận báo cáo sự kiện chi tiết. Bạn có thể tùy chỉnh các báo cáo đó để giúp bạn hiểu rõ hơn những gì đang xảy ra trong ứng dụng của mình và các trường hợp xung quanh các sự kiện được báo cáo cho Crashlytics.

  • Tự động nhận nhật ký đường dẫn nếu ứng dụng của bạn sử dụng SDK Firebase cho Google Analytics. Những nhật ký này cung cấp cho bạn khả năng hiển thị các hành động của người dùng dẫn đến sự kiện do Crashlytics thu thập trong ứng dụng của bạn.

  • 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 bạn. Lưu ý rằng, 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.

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 log và logWithFormat , 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áo cáo 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 còn cho phép bạn ghi lại các trường hợp ngoại lệ không gây tử vong và gửi chúng cho bạn vào lần tiếp theo khi ứng dụng của bạn khởi chạy.

Bạn có thể ghi lại các ngoại lệ không nghiêm trọng bằng cách ghi lại các đối tượng NSError bằng 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)

Mục tiêu-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 phương thức recordError không đúng cách 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 dấu vết ngăn xếp, các lỗi được ghi lại được nhóm theo domain và code . Đây là điểm khác biệt quan trọng giữa sự cố nghiêm trọng và lỗi được ghi lại. 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)

Mục tiêu-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 sự cố mới được nhóm theo NSSomeErrorDomain và -1001 . Các lỗi đã ghi bổ sung sử dụng cùng một giá trị tên miền và mã được nhóm vào cùng một vấn đề. Dữ liệu chứa trong đối tượng userInfo được chuyển đổi thành cặp khóa-giá trị và 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

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 giữa nhật ký được đính kèm với sự cố và lỗi được ghi. Khi xảy ra sự cố 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 cho đến thời điểm xảy ra sự cố. Khi bạn đăng nhập NSError , ứng dụng sẽ không dừng ngay lập tức. Vì Crashlytics chỉ gửi báo cáo lỗi đã ghi trong 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 nhật ký trên đĩa nên có thể ghi đủ sau khi ghi lại NSError để tất cả các nhật ký có liên quan được luân chuyển ra ngoài vào thời điểm 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 cũng như 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 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 sẽ ghi lại ngăn xếp cuộc gọi của chuỗi hiện tại bằng cách sử dụng quy trình có tên là giải phóng ngăn xếp. Quá trình này có thể đòi hỏi nhiều CPU và I/O, đặc biệt là trên các kiến ​​trúc hỗ trợ giải phóng DWARF (arm64 và x86). Sau khi quá trình thư giãn hoàn tất, thông tin sẽ đượ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ù việc gọi API này trên một luồng nền là an toàn nhưng hãy nhớ rằng việc gửi lệnh gọi này đến một hàng đợi khác sẽ làm mất bối cảnh của dấu vết ngăn xếp hiện tại.

Còn NSException thì sao?

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

Tùy chỉnh dấu vết ngăn xếp

Nếu ứng dụng của bạn chạy trong môi trường không phải môi trường gốc (chẳng hạn như C++ hoặc Unity), thì bạn có thể sử dụng API mô hình ngoại lệ để báo cáo siêu dữ liệu sự cố ở định dạng ngoại lệ gốc của ứng dụng. Các trường hợp ngoại lệ được báo cáo được đánh dấu là không gây tử vong.

Nhanh

var  ex = ExceptionModel(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(symbol:"makeError", file:"handler.js", line:495),
  StackFrame(symbol:"then", file:"routes.js", line:102),
  StackFrame(symbol:"main", file:"app.js", line:12),
]

crashlytics.record(exceptionModel:ex)

Mục tiêu-C

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithSymbol:@"makeError" file:@"handler.js" line:495],
  [FIRStackFrame stackFrameWithSymbol:@"then" file:@"routes.js" line:102],
  [FIRStackFrame stackFrameWithSymbol:@"main" file:@"app.js" line:12],
];

[[FIRCrashlytics crashlytics] recordExceptionModel:model];

Các khung ngăn xếp tùy chỉnh cũng có thể được khởi tạo chỉ bằng các địa chỉ:

Nhanh

var  ex = ExceptionModel.init(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(address:0xfa12123),
  StackFrame(address:12412412),
  StackFrame(address:194129124),
]

crashlytics.record(exceptionModel:ex)

Mục tiêu-C

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithAddress:0xfa12123],
  [FIRStackFrame stackFrameWithAddress:12412412],
  [FIRStackFrame stackFrameWithAddress:194129124],
];


[[FIRCrashlytics crashlytics] recordExceptionModel:model];

Nhận nhật ký đường dẫn

Nhật ký Breadcrumb giúp bạn hiểu rõ hơn về các 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 gây tử vong hoặc ANR. Những nhật ký này có thể hữu ích khi cố gắng tái tạo và gỡ lỗi một sự cố.

Nhật ký đường dẫn được cung cấp bởi Google Analytics, do đó, để có được nhật ký đường dẫn, 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 các yêu cầu này, nhật ký đường dẫn sẽ tự động được đưa vào dữ liệu của sự kiện trong tab Nhật ký khi bạn xem chi tiết về sự cố.

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 sự cố, sự kiện không gây tử vong hoặc ANR. Nhật ký breadcrumb screen_view chứa tham số firebase_screen_class .

Nhật ký Breadcrumb cũng được điền với bất kỳ sự kiện tùy chỉnh nào mà bạn đăng nhập theo cách thủ công trong phiên 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 gây tử vong hoặc ANR.

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 dữ liệu điền vào nhật ký đường dẫn.

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 .