Tuỳ chỉnh báo cáo sự cố trong Firebase Crashlytics

Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề để xem 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 về những gì đang xảy ra trong ứng dụng và hoàn cảnh xung quanh các sự kiện được báo cáo cho Crashlytics.

• Đo lường ứng dụng của bạn để ghi lại khoá tuỳ chỉnh, thông điệp nhật ký tuỳ chỉnh và giá trị nhận dạng người dùng.

• Báo cáo ngoại lệ cho Crashlytics.

• Tự động nhận nhật ký chuỗi liên kết nếu ứng dụng của bạn sử dụng SDK Firebase cho Google Analytics. Các nhật ký này cho bạn biết 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.

• Tắt tính năng báo cáo sự cố tự động và bật tính năng chọn tham gia báo cáo 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.

Thêm khoá tuỳ chỉnh

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

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

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

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

// 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 giá trị khác cho khoá. Ví dụ:

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

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

[[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:

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)

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

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

Crashlytics.crashlytics().log("Higgs-Boson detected! Bailing out…, \(attributesDict)")

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

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

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

Để chẩn đoán một vấn đề, bạn thường cần biết người dùng nào đã gặp phải một sự cố nhất định. Crashlytics có cách nhận dạng ẩ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ố định danh, mã thông báo hoặc giá trị băm:

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

[[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 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ã 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 trường hợp 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 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].

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

[[FIRCrashlytics crashlytics] recordError:error];

Khi sử dụng phương thức recordError, điều quan trọng là bạ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 việc báo cáo 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 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 nhật ký. Ví dụ:

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)

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 đó sẽ tạo 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ặp khoá-giá trị và hiển thị trong mục khoá/nhật ký trong từng vấn đề.

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

Tương tự 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 các sự cố so với lỗi được ghi lại. Khi sự cố xảy ra và ứng dụng được chạy lại, các 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 ghi lại 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 lại 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 lại đủ nhật ký sau khi ghi NSError để tất cả nhật ký có liên quan được xoay vòng khi Crashlytics gửi báo cáo từ thiết bị. Hãy cân nhắc điều 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.

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 có tên là tháo 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ỡ bỏ DWARF (arm64 và x86). Sau khi hoàn tất quá trình tháo dỡ, thông tin sẽ được ghi đồng bộ vào ổ đĩa. Điều này giúp tránh mất dữ liệu nếu dòng tiếp theo gặp sự cố.

Mặc dù có thể gọi API này trên luồng ở chế độ 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 cơ sở để ghi nhật ký và ghi lại các thực thể NSException trực tiếp. Nói chung, các API Cocoa và Cocoa Touch không an toàn đối với 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ụ 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 bao giờ nên 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ôi trường không phải gốc (chẳng hạn như C++ hoặc Unity), 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 nghiêm trọng.

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)

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 địa chỉ:

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)

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 giúp bạn hiểu rõ hơn về các lượt 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ể giúp ích khi bạn cố gắng tái hiện và gỡ lỗi sự cố.

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 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ý đường dẫn dẫn chiếu hiển thị danh sách màn hình đã xem trước sự kiện sự cố, 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ý chuỗi liên kết cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi lại theo cách thủ công trong phiên 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 thao tác của người dùng dẫn đến sự cố, sự cố 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 sẵn nhật ký đường dẫn.

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

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. Để 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 tính năng ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy. Giá trị ghi đè sẽ tồn tại trong các lần khởi chạy ứng dụng để Crashlytics có thể tự động thu thập báo cáo.

   Để chọn không sử dụng tính năng báo cáo sự cố tự động, hãy truyề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 tiếp theo của ứng dụng.

   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 và cho bạn biết liệu vấn đề 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 đề, tính năng Thông tin chi tiết về sự cố thậm chí còn cung cấp tài nguyên để giúp bạn gỡ lỗi sự cố.

Tính năng 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 tính nă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.