Tuỳ chỉnh báo cáo sự cố 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 được báo cáo chi tiết về sự kiện. Bạn có thể tuỳ chỉnh những báo cáo đó để hiểu rõ hơn về những gì đang xảy ra trong ứng dụng của mình và các trường hợp xung quanh những sự kiện được báo cáo cho Crashlytics.

• Đo lường ứng dụng của bạn để ghi lại các khoá tuỳ chỉnh, thông báo nhật ký tuỳ chỉnh và các 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 nhận nhật ký đường dẫn nếu ứng dụng của bạn sử dụng Firebase SDK cho Google Analytics. Các nhật ký này giúp bạn biết được những hành động của người dùng dẫn đến một sự kiện được thu thập Crashlytics trong ứng dụng của bạn.

• Tắt tính năng báo cáo sự cố tự động và bật tính năng báo cáo 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 trước khi xảy ra 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 Firebase.

• Trong Crashlyticstrang tổng quan, bạn có thể tìm kiếm những 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 đặt số nguyên, giá trị boolean hoặc số thực, hãy đóng gói giá trị dưới dạng @(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 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 NSDictionary 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 báo nhật ký tuỳ chỉnh

Để có thêm bối cảnh 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. Crashlytics sẽ liên kết nhật ký với dữ liệu sự cố và hiển thị nhật ký đó trên trang Crashlytics của bảng điều khiểnFirebase, 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 64 kB và xoá các mục nhật ký cũ hơn khi nhật ký của một phiên vượt quá giới hạn đó.

Swift

Sử dụng log() hoặc log(format:, arguments:) để giúp xác định chính xác vấn đề. Nếu bạn muốn nhận được đầu ra nhật ký hữu ích kèm theo thông báo, thì đối tượng mà bạn truyền đến log() phải tuân thủ thuộc tính CustomStringConvertible. log() trả về thuộc tính nội dung 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 thông tin về cách sử dụng log() hoặc log(format:, arguments:), hãy tham khảo Crashlytics tài liệu tham khảo.

Objective-C

Sử dụng log hoặc logWithFormat để giúp xác định chính xác vấn đề. Xin lưu ý rằng nếu bạn muốn nhận được đầu ra nhật ký hữu ích có thông báo, 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 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 thông tin về cách sử dụng log và logWithFormat, hãy tham khảo tài liệu tham khảo Crashlytics.

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

Để chẩn đoán một vấn đề, bạn nên biết người dùng nào gặp phải một sự cố nhất định. Crashlytics bao gồm một cách để xác định người dùng ẩn danh 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ưới dạng số 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ã 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 không xoá các bản ghi Crashlytics hiện có. Nếu bạn cần xoá các bản ghi được 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 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 chúng cho bạn vào lần tiếp theo ứng dụng của bạn khởi chạy.

Lưu ý: Crashlytics chỉ lưu trữ 8 trường hợp ngoại lệ gần đây nhất trong một phiên ứng dụng nhất định. Nếu ứng dụng của bạn gửi nhiều hơn 8 ngoại lệ trong một phiên, các ngoại lệ cũ hơn sẽ bị mất.

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 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 chính xác có thể gây ra hành vi không thể đoán trước và có thể khiến Crashlytics giới hạn việc 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 lỗi nghiêm trọng được nhóm thông qua phân tích dấu vết ngăn xếp, các lỗi đã ghi nhật ký đượ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ụ:

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 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 bổ sung được ghi lại bằng cùng một miền và giá trị mã sẽ được nhóm vào cùng một vấn đề. Dữ liệu có 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ý trong một vấn đề riêng lẻ.

Thận trọng: Tránh sử dụng các giá trị duy nhất, chẳng hạn như mã nhận dạng người dùng, mã nhận dạng sản phẩm và dấu thời gian trong các trường miền và mã. Việc sử dụng các giá trị riêng biệt trong những trường này sẽ gây ra nhiều vấn đề về số lượng và có thể khiến Crashlytics cần phải giới hạn việc báo cáo các lỗi đã ghi trong ứng dụng của bạn. Thay vào đó, bạn nên thêm các giá trị riêng biệt vào đối tượng từ điển userInfo.

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 về nhật ký được đính kèm vào sự cố so với lỗi được ghi nhật ký. Khi xảy ra sự cố và ứng dụng được khởi chạy lại, các nhật ký 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 ghi nhật ký một 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 nhật ký vào lần khởi chạy ứng dụng tiếp theo và phải giới hạn lượng dung lượng được phân bổ cho nhật ký trên đĩa, nên có thể ghi nhật ký đủ sau khi NSError được ghi để tất cả nhật ký có liên quan đều được xoay vòng vào thời điểm 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 và sử dụng nhật ký cũng như 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 sẽ 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 gọi là gỡ ngăn xếp. Quá trình này có thể tiêu tốn nhiều CPU và I/O, đặc biệt là trên các kiến trúc hỗ trợ tính năng gỡ lỗi DWARF (arm64 và x86). Sau khi quá trình huỷ bỏ hoàn tất, thông tin sẽ được ghi vào ổ đĩa một cách đồng bộ. Điều này giúp ngăn ngừa mất dữ liệu nếu dòng tiếp theo gặp sự cố.

Mặc dù bạn có thể yên tâm gọi API này trên một luồng nề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 NSException thì sao?

Crashlytics không cung cấp cơ sở để ghi nhật ký và ghi lại trực tiếp các phiên bản NSException. Nói chung, các API Cocoa và Cocoa Touch không an toàn cho 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ụ không mong muốn rất nghiêm trọng trong quy trình của bạn, ngay cả khi bạn sử dụng một cách hết sức cẩn thận. Bạn không bao giờ được sử dụng câu lệnh @catch trong mã. 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 là môi trường gốc (chẳng hạn như C++ hoặc Unity), bạn có thể sử 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 trường hợp ngoại lệ được báo cáo sẽ đượ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 tạo các khung ngăn xếp tuỳ chỉnh chỉ bằng các đị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

Nhật ký đường dẫn cho phép bạn hiểu rõ hơn về những lượt tương tác mà người dùng đã thực hiện với ứng dụng của bạn trước khi xảy ra sự cố, lỗi 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ý đường dẫn được cung cấp bởi Google Analytics. Vì vậy, để nhận 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 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. Điều này cho phép nhật ký đường dẫn hiển thị danh sách các màn hình đã xem trước sự kiện gặp sự cố, không nghiêm trọng hoặc ANR. Nhật ký đường dẫn screen_view chứa tham số firebase_screen_class.

Nhật ký đường dẫn cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi nhật ký theo cách thủ công trong phiên hoạt động của người dùng, bao gồm cả dữ liệu tham số của sự kiện. Dữ liệu này có thể giúp cho thấy một loạt hành động của người dùng dẫn đến sự kiện sự cố, không nghiêm trọng hoặc 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 cho nhật ký đường dẫn.

Bật báo cáo chọn sử dụng

Nếu bật tính năng báo cáo chọn tham gia bằng cách tắt tính năng báo cáo tự động, bạn sẽ giảm độ chính xác của số lượng sự kiện và các chỉ số không có sự cố của ứng dụng. Điều này khiến các chỉ số này ít phản ánh độ ổn định tổng thể của ứng dụng hơn. Tìm hiểu thêm.

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 nhiều quyền kiểm soát hơn đối với dữ liệu mà 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 tính năng 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 tính năng thu thập tự động bằng cách thêm một 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 đè tính năng thu thập dữ liệu Crashlytics tại thời gian chạy. Giá trị ghi đè sẽ duy trì trong tất cả các lần khởi chạy ứng dụng tiếp theo để Crashlytics có thể tự động thu thập báo cáo cho người dùng đó.

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

   Nếu sau này người dùng chọn không thu thập dữ liệu, bạn có thể truyền false làm giá trị ghi đè. Giá trị này sẽ áp dụng vào lần tiếp theo người dùng chạy ứng dụng và sẽ duy trì trong tất cả các lần chạy tiếp theo cho người dùng đó.

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

Quản lý dữ liệu trong 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 các dấu vết ngăn xếp ẩn danh của bạn với dấu vết của các ứng dụng Firebase khác và 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 các 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 ổn định thường gặp. 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ố trong 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 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 đến 24 giờ mới có hiệu lực.