自定義您的 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：

通過向Info.plist文件添加新密鑰來關閉自動收集：
- 鍵： FirebaseCrashlyticsCollectionEnabled
- 值： false
通過在運行時調用 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。