自訂您的 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 會自動收集應用程式的所有使用者崩潰的報告。為了讓使用者更好地控制他們發送的數據，您可以透過停用自動報告來啟用選擇加入報告，並且僅當您在程式碼中選擇時才將數據傳送到 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。