Tuỳ chỉnh báo cáo lỗi trong Firebase Crashlytics

Trên 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 những gì đang xảy ra trong ứng dụng của mình và các trường hợp xảy ra liên quan đến 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. Các nhật ký này giúp bạn xem được 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 chọn sử dụng để báo cáo cho người dùng. Xin lưu ý rằng 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.

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 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 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 liên kết cho từng sự kiện (thẻ con Khoá) và thậm chí là lọc sự kiện theo các khoá tuỳ chỉnh (trình đơn Bộ lọc ở đầu trang).

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 có độ chính xác đơn, 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 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 NS từ điển 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

Để tự tìm hiểu thêm về các sự kiện dẫn đến 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 về sự cố và hiển thị các nhật ký đó trên trang Crashlytics của bảng điều khiển của Firebase, trong thẻ Nhật ký.

Swift

Hãy sử dụng log() hoặc log(format:, arguments:) để giúp xác định sự cố. Nếu bạn muốn nhận đầu ra nhật ký hữu ích với các thông điệp, đối tượng mà bạn truyền đến log() phải phù hợp với 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 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 sự cố. Lưu ý rằng nếu bạn muốn nhận đầu ra nhật ký hữu ích với thông điệp, đối tượng mà bạn truyền vào 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 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 sự cố, bạn nên biết được 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ố.

Để 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ố 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á 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 nhóm hỗ trợ Firebase.

Báo cáo các trường hợp ngoại lệ không nghiêm trọng

Ngoài việc tự động báo cáo sự cố của ứng dụng, Crashlytics còn cho phép bạn ghi lại các ngoại lệ không nghiêm trọng và gửi 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 bằng phương thức recordError. recordError ghi lại ngăn xếp lệnh gọi của luồng bằng cách gọi [NSThread callStackReturnAddresses].

Swift 

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

Objective-C 

[[FIRCrashlytics crashlytics] recordError:error];

Khi sử dụng phương thức recordError, bạn cần 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 ngoài dự đoán và có thể khiến Crashlytics giới hạn báo cáo các lỗi đã ghi cho ứng dụng của bạn.

Đối tượng NSError có 3 đố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 thông qua tính năng phân tích dấu vết ngăn xếp, các lỗi đã 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 đã ghi lại. Ví dụ:

Swift 

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 ở trên, lỗi này sẽ tạo ra một vấn đề mới được nhóm theo NSSomeErrorDomain và -1001. Các lỗi khác đã ghi lại sử dụng cùng một miền và giá trị 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ác cặp khoá-giá trị và hiển thị trong phần khoá/nhật ký của một vấn đề riêng lẻ.

Nhật ký và khoá tuỳ chỉnh

Giống như báo cáo sự cố, bạn có thể nhúng nhật ký và khoá tuỳ chỉnh để thêm ngữ cảnh vào NSError. Tuy nhiên, có sự khác biệt giữa việc nhật ký nào được đính kèm vào sự cố và lỗi đã ghi lại. Khi xảy ra sự cố và ứng dụng được chạy lại, nhật ký Crashlytics truy xuất từ ổ đĩa là những nhật ký được ghi cho đến thời điểm xảy ra sự cố. Khi bạn ghi NSError, ứng dụng sẽ không chấm dứt 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 bạn có thể ghi nhật ký đủ sau khi NSError được ghi lại để tất cả nhật ký có liên quan đều được xoay vòng khi Crashlytics gửi báo cáo từ thiết bị. Hãy lưu ý sự cân bằng này khi ghi nhật ký NSErrors cũng như sử dụng nhật ký và khoá tuỳ chỉnh trong ứng dụng của bạn.

Xem xét hiệu suất

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

Mặc dù có thể gọi API này trên 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 ngữ cảnh của dấu vết ngăn xếp hiện tại.

Còn NSExceptions thì sao?

Crashlytics không cung cấp tiện ích để ghi nhật ký và ghi lại trực tiếp các thực thể NSException. Nhìn chung, các API Cacao và Cacao Touch không phải là loại ngoại lệ an toàn. Điều đó có nghĩa là việc sử dụng @catch có thể gây ra những tác dụng phụ rất nghiêm trọng không mong muốn trong quy trình của bạn, ngay cả khi sử dụng hết sức cẩn thận. Bạn không được 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.

Tuỳ chỉnh dấu vết ngăn xếp

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

Swift 

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)

Objective-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];

Bạn cũng có thể khởi chạy khung ngăn xếp tuỳ chỉnh chỉ bằng địa chỉ:

Swift 

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)

Objective-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ý 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ề những hành động 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ể hữu ích khi bạn cố gắng tái tạo và gỡ lỗi một vấn đề.

Nhật ký breadcrumb (tập hợp liên kết phân cấp) do Google Analytics cung cấp. Vì vậy, để nhận nhật ký breadcrumb (tập hợp liên kết phân cấp), bạn cần bật Google Analytics cho dự án Firebase và thêm Firebase SDK 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ý breadcrumb (tập hợp liên kết phân cấp) 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ý breadcrumb (tập hợp liên kết phân cấp) hiển thị danh sách các màn hình đã xem trước sự kiện sự cố, sự kiện không nghiêm trọng hoặc sự kiện ANR. Nhật ký breadcrumb (tập hợp liên kết phân cấp) 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 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 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 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 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 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 sử dụng 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 sử dụng 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 cơ chế ghi đè thu thập dữ liệu 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 của bạn để 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 chuyển false dưới dạng giá trị ghi đè. Khi bạn đặ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];

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, đồng thời cho bạn biết liệu vấn đề của bạn có nằm trong 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ố.

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 Thông tin chi tiết về sự cố trên 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 của Firebase.