Firebase 将于 5 月 14 日重返 Google I/O 大会！立即报名。

本頁面由 Cloud Translation API 翻譯而成。

自訂 Firebase Crashlytics 當機報告

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

檢測應用程式，以記錄自訂金鑰、自訂記錄訊息和使用者 ID。
向 Crashlytics 回報例外狀況。

如果應用程式使用 Google Analytics (分析) 專用 Firebase SDK，會自動取得導覽標記記錄。這些記錄檔可讓您瞭解使用者在您的應用程式中觸發 Crashlytics 收集事件的使用者動作。
關閉自動當機回報功能，並為使用者啟用選擇加入回報功能。請注意，根據預設，Crashlytics 會自動收集所有應用程式使用者的當機報告。

新增自訂鍵

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

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

使用 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)")

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

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 能讓您在當機報告中以匿名方式識別使用者。

如要將使用者 ID 新增至報表，請以 ID 號碼、權杖或雜湊值的形式為每位使用者指派專屬 ID：

Swift

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

Objective-C

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

如果您需要清除使用者 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) 中執行，您可以使用 Exception Model 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 (分析)，並在應用程式中新增 Firebase SDK for Google Analytics。只要符合這些要求，系統就會在「記錄檔」分頁中自動加入導覽標記記錄，並在問題詳細資料中附上事件資料。

Analytics (分析) SDK 會自動記錄 screen_view 事件，讓導覽標記記錄列出當機、一般或 ANR 事件發生前的瀏覽畫面清單。screen_view 導覽標記記錄包含 firebase_screen_class 參數。

此外，導覽標記記錄也會填入您在使用者工作階段中手動記錄的所有自訂事件，包括事件的參數資料。這項資料有助於顯示各種會導致當機、一般或 ANR 事件的使用者動作。

請注意，您可以控管 Google Analytics (分析) 資料的收集和使用方式，包括填入導覽標記記錄的資料。

啟用選用報表

根據預設，Crashlytics 會自動收集所有應用程式使用者的當機報告。如要讓使用者進一步控管他們傳送的資料，您可以啟用自動回報功能，方法是停用自動回報功能，並且在選擇使用程式碼中時，才將資料傳送至 Crashlytics：

如要關閉自動收集功能，請在 Info.plist 檔案中新增金鑰：
- 金鑰：FirebaseCrashlyticsCollectionEnabled
- 值：false
在執行階段呼叫 Crashlytics 資料收集覆寫，為特定使用者啟用收集功能。在應用程式啟動時，覆寫值仍會維持不變，以便 Crashlytics 自動收集報表。

如要停用自動當機回報功能，請將 false 傳遞為覆寫值。如果設為 false，則新值必須等到下次執行應用程式時才會套用。
Swift
```
Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)
```
Objective-C
```
[[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];
```

管理「當機深入分析」資料

Crash Insights 會比較匿名堆疊追蹤與其他 Firebase 應用程式的追蹤記錄，並讓您瞭解問題是否屬於較大的趨勢中。針對許多問題，當機深入分析甚至提供資源，協助您偵錯當機問題。

當機深入分析會使用匯總的當機資料找出常見的穩定性趨勢。如果您不想提供應用程式資料，可以前往 Firebase 控制台，在 Crashlytics 問題清單頂端的「當機深入分析」選單中，選擇停用「當機深入分析」。

自訂 Firebase Crashlytics 當機報告

新增自訂鍵

Swift

Objective-C

Swift

Objective-C

Swift

Objective-C

新增自訂記錄訊息

Swift

Objective-C

設定使用者 ID

Swift

Objective-C

回報不嚴重的例外狀況

Swift

Objective-C

Swift

Objective-C

記錄和自訂金鑰

效能注意事項

那 NSExceptions 呢？

自訂堆疊追蹤

Swift

Objective-C

Swift

Objective-C

取得導覽標記記錄

啟用選用報表

Swift

Objective-C

管理「當機深入分析」資料