自訂您的 Firebase Crashlytics 崩潰報告

本指南介紹如何使用 Firebase Crashlytics SDK 自訂崩潰報告。預設情況下，Crashlytics 會自動收集應用程式的所有使用者的崩潰報告（您可以關閉自動崩潰報告並為使用者啟用選擇加入報告）。 Crashlytics 提供了四種開箱即用的日誌記錄機制：自訂鍵、自訂日誌、使用者識別碼和擷取的異常。

新增自訂鍵

自訂鍵可協助您取得應用程式導致崩潰的特定狀態。您可以將任意鍵/值對與崩潰報告關聯，然後使用自訂鍵在 Firebase 控制台中搜尋和篩選崩潰報告。

  • 在Crashlytics 儀表板中，您可以搜尋與自訂鍵相符的問題。
  • 當您在控制台中查看特定問題時，您可以查看每個事件的關聯自訂鍵（ “鍵”子選項卡），甚至可以按自訂鍵過濾事件（頁面頂部的“過濾器”功能表）。

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

迅速

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

您也可以透過呼叫該鍵並將其設定為不同的值來修改現有鍵的值。例如：

迅速

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 作為唯一參數）批次新增鍵/值對：

迅速

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 頁面的「日誌」標籤下。

迅速

使用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參考文件。

設定用戶標識符

要診斷問題，了解哪些用戶遇到了給定的崩潰通常很有幫助。 Crashlytics 包含一種在崩潰報告中匿名識別使用者的方法。

若要將使用者 ID 新增至報表中，請為每個使用者指派 ID 號碼、令牌或雜湊值形式的唯一識別碼：

迅速

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

Objective-C

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

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

報告非致命異常

除了自動報告應用程式的崩潰之外，Crashlytics 還允許您記錄非致命異常，並在下次應用程式啟動時將其發送給您。

您可以透過使用recordError方法記錄NSError物件來記錄非致命異常。 recordError透過呼叫[NSThread callStackReturnAddresses]來捕捉執行緒的呼叫堆疊。

迅速

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分組。這是致命崩潰和記錄錯誤之間的重要區別。例如：

迅速

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）中執行，您可以使用異常模型 API 以應用程式的本機異常格式報告崩潰元資料。報告的異常被標記為非致命的。

迅速

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

自訂堆疊幀也可以僅使用位址進行初始化：

迅速

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

啟用選擇加入報告

預設情況下，Crashlytics 會自動收集應用程式的所有使用者崩潰的報告。為了讓使用者更好地控制他們發送的數據，您可以透過停用自動報告來啟用選擇加入報告，並且僅當您在程式碼中選擇時才將數據傳送到 Crashlytics：

  1. 透過向Info.plist檔案新增金鑰來關閉自動收集：

    • 鍵： FirebaseCrashlyticsCollectionEnabled
    • 值： false

  2. 透過在執行時呼叫 Crashlytics 資料收集覆蓋來為選定使用者啟用收集。覆蓋值在應用程式啟動時持續存在，因此 Crashlytics 可以自動收集報告。

    若要退出自動崩潰報告，請傳遞false作為覆蓋值。當設定為false時，新值直到下次執行應用程式時才會套用。

    迅速

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Objective-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

管理崩潰洞察數據

Crash Insights 透過將匿名堆疊追蹤與其他 Firebase 應用程式的追蹤進行比較來幫助您解決問題，並讓您知道您的問題是否屬於更大趨勢的一部分。對於許多問題，Crash Insights 甚至提供資源來幫助您調試崩潰。

崩潰洞察使用聚合的崩潰資料來識別常見的穩定性趨勢。如果您不想共享應用程式的數據，可以從Firebase 控制台Crashlytics 問題清單頂部的Crash Insights選單中選擇退出 Crash Insights。