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

自訂 Firebase Crashlytics 當機報告

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

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

如果應用程式使用 Firebase SDK for Google Analytics，系統會自動取得麵包屑記錄。這些記錄檔可讓您瞭解使用者在應用程式中觸發 Crashlytics 收集的事件前，所執行的動作。
為使用者關閉自動當機報告功能，並啟用選擇加入回報功能。請注意，根據預設，Crashlytics 會自動收集所有應用程式使用者的當機報告。

新增自訂鍵

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

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

使用 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 不會移除現有記錄。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 是安全的，但請注意，將這個呼叫分派至其他佇列會遺失目前堆疊追蹤的內容。

NSException 呢？

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 可以自動為該使用者收集報表。
Swift
```
Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)
```
Objective-C
```
[[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];
```
如果使用者之後選擇停用資料收集功能，您可以傳遞 false 做為覆寫值，系統會在使用者下次啟動應用程式時套用該值，並在該使用者後續啟動應用程式時持續套用。

管理當機深入分析資料

當機深入分析功能會比較您應用程式的匿名堆疊追蹤記錄與其他 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

記錄和自訂鍵

效能注意事項

NSException 呢？

自訂堆疊追蹤記錄

Swift

Objective-C

Swift

Objective-C

取得導覽標記記錄

啟用選擇加入回報功能

Swift

Objective-C

管理當機深入分析資料