自訂 Firebase Crashlytics 當機報告


在 Crashlytics 資訊主頁中，您可以點選問題並取得詳細的事件報表。您可以自訂這些報表，進一步瞭解應用程式發生的情況，以及向 Crashlytics 回報的事件相關情況。

  • 如果應用程式使用 Google Analytics 的 Firebase SDK，系統會自動取得麵包屑記錄。這些記錄檔可讓您瞭解導致應用程式中 Crashlytics 收集事件的使用者動作。

  • 請關閉自動當機回報功能，並為使用者啟用選擇加入式回報功能。請注意，根據預設，Crashlytics 會自動為應用程式的所有使用者收集當機報告。

新增自訂鍵

您可以使用自訂鍵，取得導致當機情況的應用程式特定狀態。您可以將任意鍵/值組合與當機報告建立關聯，然後使用自訂鍵在 Firebase 主控台中搜尋及篩選當機報告。

  • 您可以在 Crashlytics 資訊主頁中搜尋符合自訂鍵的問題。
  • 在控制台中查看特定問題時，您可以查看每個事件的相關自訂鍵 (「Keys」子頁籤)，甚至可以依據自訂鍵篩選事件 (頁面頂端的「Filter」選單)。

使用 setCustomValue 方法設定鍵/值組合。例如：

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

設定整數、布林值或浮點值時，請將值以 @(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"];

您也可以呼叫鍵並將其設為其他值，藉此修改現有鍵的值。例如：

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

使用 setCustomKeysAndValues 方法，並將 NSDictionary 做為唯一參數，即可大量新增鍵/值組合：

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

新增自訂記錄訊息

如要進一步瞭解導致當機的事件，您可以將自訂 Crashlytics 記錄檔新增至應用程式。Crashlytics 會將記錄檔與當機資料建立關聯，並在 Firebase 控制台的「記錄檔」分頁標籤下方的 Crashlytics 頁面中顯示這些資料。

Swift

使用 log() 或 log(format:, arguments:) 來找出問題。如果您想取得含有訊息的實用記錄輸出內容，則傳遞至 log() 的物件必須符合 CustomStringConvertible 屬性。log() 會傳回您為物件定義的說明屬性。例如：

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

.log(format:, arguments:) 會將呼叫 getVaList() 傳回的值格式化。例如：

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

如要進一步瞭解如何使用 log() 或 log(format:, arguments:)，請參閱 Crashlytics 參考說明文件。

Objective-C

使用 log 或 logWithFormat 來找出問題。請注意，如果您想取得含有訊息的實用記錄輸出內容，則傳遞至任一方法的物件必須覆寫 description 例項屬性。例如：

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

如要進一步瞭解如何使用 log 和 logWithFormat，請參閱 Crashlytics 參考說明文件。

設定使用者 ID

如要診斷問題，通常需要瞭解哪些使用者發生特定異常終止情形。Crashlytics 包含匿名識別當機報告中使用者的方法。

如要在報表中新增 User-ID，請為每位使用者指派專屬 ID，形式可為 ID 編號、符記或雜湊值：

Swift 

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

Objective-C 

[[FIRCrashlytics crashlytics] setUserID:@"123456789"];

如果您需要在設定使用者 ID 後清除該 ID，請將值重設為空白字串。清除使用者 ID 不會刪除現有的 Crashlytics 記錄。如要刪除與使用者 ID 相關聯的記錄，請與 Firebase 支援團隊聯絡。

回報非致命例外狀況

除了自動回報應用程式的當機情形，Crashlytics 還可讓您記錄非嚴重例外狀況，並在下次啟動應用程式時傳送給您。

您可以使用 recordError 方法記錄 NSError 物件，藉此記錄非致命的例外狀況。recordError 會呼叫 [NSThread callStackReturnAddresses] 來擷取執行緒的呼叫堆疊。

Swift 

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

Objective-C 

[[FIRCrashlytics crashlytics] recordError:error];

使用 recordError 方法時，請務必瞭解 NSError 結構，以及 Crashlytics 如何使用資料將當機事件分組。如果使用 recordError 方法時出錯，可能會導致無法預測的行為，並可能導致 Crashlytics 限制應用程式記錄錯誤的回報。

NSError 物件有三個引數：

  • domain: String
  • code: Int
  • userInfo: [AnyHashable : Any]? = nil

與透過堆疊追蹤分析進行分組的致命當機不同，記錄的錯誤會依 domain 和 code 分組。這正是致命當機和記錄錯誤之間的重要差異。例如：

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

記錄上述錯誤時，系統會建立新問題，並按 NSSomeErrorDomain 和 -1001 分組。使用相同網域和代碼值的其他記錄錯誤會歸入同一問題。userInfo 物件內含的資料會轉換為鍵/值組合，並顯示在個別問題的「鍵/記錄」專區中。

記錄和自訂鍵

就像當機報告一樣，您可以嵌入記錄和自訂索引鍵，為 NSError 新增背景資訊。不過，與記錄的錯誤相比，系統會將不同的記錄附加至當機事件。當發生當機並重新啟動應用程式時，Crashlytics 從磁碟擷取的記錄，就是在當機前寫入的記錄。當您記錄 NSError 時，應用程式不會立即終止。由於 Crashlytics 只會在下次啟動應用程式時傳送記錄的錯誤報告，且必須限制磁碟上記錄檔案所需的空間量，因此在記錄 NSError 後，您可以記錄足夠的記錄，以便在 Crashlytics 從裝置傳送報告時，將所有相關記錄輪替。在應用程式中記錄 NSErrors 及使用記錄和自訂鍵時，請留意這項平衡。

效能注意事項

請注意，記錄 NSError 可能會產生相當高的費用。在您發出呼叫時，Crashlytics 會使用稱為堆疊解開的程序，擷取目前執行緒的呼叫堆疊。這個程序可能會大量使用 CPU 和 I/O，特別是在支援 DWARF 解開 (arm64 和 x86) 的架構中。解開作業完成後，系統會同步將資訊寫入磁碟。這樣可避免下一個程式碼行程式碼發生當機時資料遺失。

雖然在背景執行緒上呼叫這個 API 是安全的，但請注意，將這個呼叫調度至其他佇列會導致目前堆疊追蹤的內容遺失。

那 NSExceptions 呢？

Crashlytics 不提供直接記錄及記錄 NSException 例項的設施。一般來說，Cocoa 和 Cocoa Touch API 並非例外狀況安全。也就是說，即使您非常小心地使用 @catch，仍可能在程序中產生非常嚴重的非預期副作用。請勿在程式碼中使用 @catch 陳述式。請參閱 Apple 的說明文件，瞭解相關資訊。

自訂堆疊追蹤記錄

如果應用程式是在非原生環境 (例如 C++ 或 Unity) 中執行，您可以使用例外狀況模型 API，以應用程式原生例外狀況格式回報當機中繼資料。回報的例外狀況會標示為非致命事件。

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

您也可以只使用位址來初始化自訂堆疊框架：

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

取得導覽標記記錄

導覽標記記錄可讓您進一步瞭解使用者與應用程式互動時，導致當機、非致命錯誤或 ANR 事件的情形。嘗試重現問題並進行偵錯時，這些記錄可能會很有幫助。

麵包屑記錄由 Google Analytics 提供支援，因此如要取得麵包屑記錄，您必須為 Firebase 專案啟用 Google Analytics，並將 Google Analytics 的 Firebase SDK 新增至應用程式。滿足這些需求後，您查看問題詳細資料時，系統就會在「Logs」分頁中，自動將麵包屑記錄與事件資料一併顯示。

Analytics SDK 會自動記錄 screen_view 事件，讓導覽標記記錄顯示在當機、非致命或 ANR 事件前檢視的畫面清單。screen_view 麵包屑記錄包含 firebase_screen_class 參數。

麵包屑記錄也會填入您在使用者工作階段中手動記錄的任何自訂事件，包括事件的參數資料。這項資料有助於顯示導致當機、非致命錯誤或 ANR 事件的一系列使用者動作。

請注意，您可以控管 Google Analytics 資料的收集和使用方式，包括填入麵包屑記錄的資料。

啟用選擇加入回報功能

根據預設，Crashlytics 會自動為應用程式的所有使用者收集當機報告。為讓使用者進一步控管所傳送的資料，您可以停用自動回報功能，並在程式碼中選擇傳送資料至 Crashlytics，啟用選擇加入回報功能：

  1. 如要關閉自動收集功能，請在 Info.plist 檔案中新增一個鍵：

    • 鍵：FirebaseCrashlyticsCollectionEnabled
    • 值：false

  2. 在執行階段呼叫 Crashlytics 資料收集覆寫值，即可為特定使用者啟用收集功能。覆寫值會在應用程式啟動期間持續存在，以便 Crashlytics 自動收集報表。

    如要停用自動當機報告功能，請將 false 做為覆寫值傳遞。將其設為 false 時，新值會在下次執行應用程式時才套用。

    Swift 

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Objective-C 

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

管理當機深入分析資料

當機深入分析功能會將您的去識別化堆疊追蹤與其他 Firebase 應用程式的追蹤記錄進行比較，協助您解決問題，並讓您瞭解問題是否屬於更廣泛的趨勢。針對許多問題，Crash Insights 甚至會提供資源，協助您偵錯當機情形。

Crash Insights 會使用匯總的當機資料，找出常見的穩定性趨勢。如果您不想分享應用程式資料，可以在 Firebase 控制台的 Crashlytics 問題清單頂端，透過「Crash Insights」選單選擇停用這項功能。