Tuỳ chỉnh báo cáo sự cố cho các nền tảng của Apple

Chọn nền tảng: iOS+ Android Flutter Unity


Bạn có thể nhấp vào một vấn đề và xem báo cáo Sự kiện chi tiết trong trang tổng quan DevOps và Mức độ tương tác > Crashlytics của bảng điều khiển Firebase. 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à các trường hợp liên quan đến sự kiện được báo cáo cho Crashlytics.

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 trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase.

  • 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 liên kết cho từng sự kiện (thẻ con Keys (Khoá)) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Filter (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, hãy đóng hộp 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 giá trị khác cho khoá. 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 điệp nhật ký tuỳ chỉnh

Để có 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 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ị nhật ký trong thẻ Logs (Nhật ký) khi bạn xem thông tin chi tiết về một vấn đề (xem tất cả vấn đề trong trang tổng quan DevOps & Engagement (DevOps và mức độ tương tác) > Crashlytics của bảng điều khiển Firebase).

Swift

Sử dụng log() hoặc log(format:, arguments:) để xác định chính xác vấn đề. Nếu muốn nhận được kết quả 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 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 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 về Crashlytics.

Objective-C

Sử dụng log hoặc logWithFormat để xác định chính xác 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, 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 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 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 người dùng nào đã gặp phải một sự cố nhất định. Crashlytics có 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 riêng biệ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á giá trị nhận dạng người dùng sau khi đặt, hãy đặt lại giá trị này 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ợ của Firebase.

Báo cáo 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 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 thu thập 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 rõ 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 lường trước và có thể khiến Crashlytics giới hạn việc báo cáo lỗi đã 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ư sự cố nghiêm trọng được nhóm thông qua phân tích dấu vết ngăn xếp, 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ụ:

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 khác được ghi lại mà sử dụ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ẻ.

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 sự cố so với lỗi được ghi lại. 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 ngay trước thời điểm xảy ra sự cố. Khi bạn ghi nhật ký 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 dung lượng được phân bổ cho nhật ký trên ổ đĩa, nên có thể ghi nhật ký đủ sau khi ghi lại NSError để tất cả nhật ký liên quan đượ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 ý đến 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.

Xem xét hiệu suất

Xin lưu ý rằng việc ghi nhật ký NSError có thể tốn khá nhiều tài nguyên. Tại thời điểm bạn thực hiện lệnh gọi, Crashlytics sẽ thu thập 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ể tốn nhiều CPU và I/O, đặc biệt là trên các cấu trúc hỗ trợ giải nén DWARF (arm64 và x86). Sau khi quá trình gỡ 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 chặn việc mất dữ liệu nếu dòng tiếp theo gặp sự cố.

Mặc dù bạn có thể gọi API này một cách an toàn trên 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 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 một cách trực tiếp. 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 các 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 được sử dụng một cách cực kỳ cẩn thận. Bạn không bao giờ được sử dụng câu lệnh @catch trong mã của mình. Hãy 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), thì bạn có thể sử dụng API Mô hình ngoại lệ để 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ệ đượ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 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];

Lấy nhật ký dấu vết

Nhật ký dấu vết giúp bạn hiểu rõ hơn về các hoạt động tương tác của người dùng 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 lỗi ANR. Các nhật ký này có thể hữu ích khi bạn cố gắng tái hiện và gỡ lỗi một vấn đề.

Nhật ký dấu vết được cung cấp bởi Google Analytics, vì vậy, để nhận nhật ký dấu vết, bạn cần bật Google Analytics cho dự án Firebase của mình và thêm Firebase SDK cho Google Analytics vào ứng dụng. Sau khi đáp ứng các yêu cầu này, nhật ký dấu vết 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 đề (xem tất cả vấn đề trong trang tổng quan DevOps và Mức độ tương tác > Crashlytics của bảng điều khiển Firebase).

SDK Analytics tự động ghi lại sự kiện screen_view, cho phép nhật ký dấu vết hiển thị danh sách các màn hình đã xem trước khi xảy ra sự kiện lỗi, sự kiện không nghiêm trọng hoặc sự kiện ANR. Nhật ký dấu vết screen_view chứa tham số firebase_screen_class.

Nhật ký dấu vế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 hành động của người dùng dẫn đến sự cố, lỗi không nghiêm trọng hoặc lỗi 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ý dấu vết.

Bật tính năng báo cáo chọn sử dụ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. Để người dùng có thêm quyền kiểm soát đố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 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:

    • 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 đè 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 đó người dùng chọn không tham gia 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ẽ được duy trì trong tất cả các lần chạy tiếp theo của người dùng đó.

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 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 đề, 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ố.

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 ổn định phổ biến. Nếu không muốn chia sẻ dữ liệu của ứng dụng, bạn có thể chọn không tham gia 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 đề trong trang tổng quan DevOps và mức độ gắn bó > Crashlytics của bảng điều khiển Firebase.

Các bước tiếp theo