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

iOS trở lên Android Flutter Unity

Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và nhận thông tin chi tiết báo cáo sự kiện. 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 bạn và những tình huống liên quan đến 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 đ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ý đườ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 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 báo cáo chọn tham gia cho người dùng của mình. Lưu ý rằng, bằng cách Crashlytics 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.

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 các vấn đề khớp với khoá tuỳ 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 khoá tuỳ chỉnh được liên kết cho từng sự kiện (thẻ phụ Khoá) và thậm chí lọc sự kiện bằng 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 đạt đến ngưỡng này, nên 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, 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 một khoá hiện có bằng cách gọi khoá và chế độ cài đặ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 giá trị/khoá bằng cách sử dụng phương thức setCustomKeysAndValues với NS từ điển là 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

Để có thêm bối cảnh về những sự kiện dẫn đến tai nạn, bạn có thể thêm nhật ký Crashlytics tuỳ chỉnh vào ứng dụng của bạn. 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 Bảng điều khiển của Firebase, 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 64kB và xoá các mục nhập nhật ký cũ hơn khi nhật ký của một phiên vượt quá giới hạn đó.

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 được đầ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 tuân thủ CustomStringConvertible thuộc tính này. log() trả về thuộc tính mô tả mà bạn xác định đối tượng. Ví dụ:

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

Giá trị định dạng .log(format:, arguments:) đượ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:), tham khảo Crashlytics tài liệu tham khảo.

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 được kết quả nhật ký hữu ích với các thông điệp, đối tượng mà bạn truyền cho một trong hai phương thức đều 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 chi tiết về cách sử dụng log và logWithFormat, hãy tham khảo Tài liệu tham khảo về 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 được người dùng nào đã gặp phải vấn đề một sự cố cụ thể. Crashlytics có một cách giúp xác định danh tính ẩn danh của người dùng 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 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 trong 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á 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á một giá trị nhận dạng người dùng sẽ không xoá giá trị nhận dạng hiện có Bản ghi Crashlytics. Trường hợp bạn cần xoá các bản ghi được liên kết với một người dùng Mã nhận 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 khởi chạy.

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

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 cuộc 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 rõ NSError cấu trúc và cách Crashlytics sử dụng dữ liệu để nhóm các sự cố. Không chính xác việc sử dụng phương thức recordError có thể gây ra hành vi ngoài dự đoán và khiến Crashlytics giới hạn báo cáo lỗi được ghi lại 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, lỗi đã ghi lại được nhóm theo domain và code. Đây là một điểm khác biệt quan trọng giữa sự cố nghiêm trọng và lỗi đã ghi nhật ký. 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 đã ghi khác sử dụng cùng một lỗi các giá trị miền và mã đượ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 khoá/nhật ký trong từng 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ã sản phẩm và dấu thời gian trong trường miền và mã. Việc sử dụng các giá trị duy nhất trong các trường này sẽ khiến số lượng giá trị riêng biệt của các vấn đề và có thể dẫn đến việc Crashlytics cần giới hạn báo cáo lỗi được ghi lại trong ứng dụng của mình. Thay vào đó, bạn nên thêm các giá trị duy nhấ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 bối cảnh NSError. Tuy nhiên, có một điểm khác biệt về nội dung đính kèm với nhật ký so với lỗi đã ghi. Khi xảy ra sự cố và ứng dụng được chạy lại, nhật ký mà Crashlytics truy xuất từ ổ đĩa là những nhật ký được ghi đến thời điểm xảy ra sự cố. Khi bạn ghi nhật ký NSError, ứng dụng sẽ không ngay lập tức chấm dứt. Bởi vì Crashlytics chỉ gửi báo cáo lỗi được ghi lại trên lần khởi chạy ứng dụng tiếp theo và phải giới hạn mức dung lượng được phân bổ cho nhật ký trên ổ đĩa, có thể ghi lại đủ sau khi NSError được ghi lại để mọi nhật ký được xoay vòng khi Crashlytics gửi báo cáo từ thiết bị. Hãy ghi nhớ số dư này khi ghi nhật ký NSErrors cũng như sử dụng nhật ký và trong ứng dụng của mình.

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. Vào 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 chuỗi hiện tại bằng cách sử dụng 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ợ gỡ bỏ 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ù vẫn có thể gọi điện an toàn API này trên luồng ở chế độ nền, hãy nhớ rằng gửi lệnh gọi này đến một luồng khác hàng đợi sẽ 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 NSException thực thể. Nói chung, các API Cacao và Cacao không phải là an toàn với ngoại lệ. Điều đó có nghĩa là việc sử dụng @catch có thể gây ra nhầm lẫn tác dụng phụ trong quy trình của bạn, ngay cả khi sử dụng một cách cẩn thận. Bạn không nên bao giờ sử dụng câu lệnh @catch trong mã của bạn. 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à gốc (chẳng hạn như C++ hoặc Unity), thì bạn có thể sử dụng Exception Model API để báo cáo siêu dữ liệu về sự cố trong 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ề hoạt động tương tác của người dùng gặp phải 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 cố gắng tái tạo và gỡ lỗi sự cố.

Nhật ký Breadcrumb do Google Analytics cung cấp, do đó, để lấy nhật ký breadcrumb, bạn cần bật Google Analytics cho dự án Firebase của bạn và thêm Firebase SDK cho Google Analytics cho ứng dụng của bạn. Khi các yêu cầu này được đáp ứng, nhật ký breadcrumb (tập hợp liên kết phân cấp) sẽ tự động kèm theo 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 đề nào đó.

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ự cố, sự cố 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 bất kỳ sự kiện tùy chỉnh mà bạn tự ghi lại trong phiên hoạt độ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ị hành động 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 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. Để 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 chọn tham gia báo cáo bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu cho 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 khoá mới vào tệp Info.plist:

   • Khoá: 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 dữ liệu trên Crashlytics ghi đè bộ sưu tập trong thời gian chạy. Giá trị ghi đè vẫn tồn tại trên số 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 đượ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 .

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

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

Quản lý dữ liệu Thông tin chi tiết về sự cố

Crash Insights giúp bạn giải quyết vấn đề bằng cách so sánh ngăn xếp ẩn danh dấu vết từ các ứng dụng Firebase khác và cho bạn biết vấn đề của một xu hướng lớn hơn. Đố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 Crash Insights trên trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề trong Crashlytics trong bảng điều khiển của Firebase.

Lưu ý: Việc tắt tính năng chia sẻ dữ liệu cũng sẽ xoá thông tin chi tiết về các vấn đề của bạn. Thay đổi có thể mất tới 24 giờ mới có hiệu lực.