自定義您的 Firebase Crashlytics 崩潰報告

本指南介紹如何使用 Firebase Crashlytics SDK 自定義崩潰報告。默認情況下,Crashlytics 會自動為您應用的所有用戶收集崩潰報告(您可以關閉自動崩潰報告並為您的用戶啟用選擇加入報告)。 Crashlytics 提供了四種開箱即用的日誌記錄機制:自定義鍵自定義日誌用戶標識符捕獲的異常

添加自定義鍵

自定義鍵可幫助您了解導致崩潰的應用的特定狀態。您可以將任意鍵/值對與崩潰報告相關聯,然後使用自定義鍵在 Firebase 控制台中搜索和過濾崩潰報告。

  • Crashlytics 儀表板中,您可以搜索與自定義鍵匹配的問題。

  • 當您在控制台中查看特定問題時,您可以查看每個事件的關聯自定義鍵(子選項卡),甚至可以通過自定義鍵過濾事件(頁面頂部的過濾器菜單)。

使用setCustomKey實例方法設置鍵/值對。請注意,對於value參數, setCustomKey被重載以接受任何原始參數或String參數。這裡有些例子:

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("my_string_key", "foo" /* string value */);

crashlytics.setCustomKey("my_bool_key", true /* boolean value */);

crashlytics.setCustomKey("my_double_key", 1.0 /* double value */);

crashlytics.setCustomKey("my_float_key", 1.0f /* float value */);

crashlytics.setCustomKey("my_int_key", 1 /* int value */);

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("my_string_key", "foo") // String value
    key("my_bool_key", true)    // boolean value
    key("my_double_key", 1.0)   // double value
    key("my_float_key", 1.0f)   // float value
    key("my_int_key", 1)        // int value
}

您還可以通過調用鍵並將其設置為不同的值來修改現有鍵的值。例如:

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

通過將CustomKeysAndValues的實例傳遞給setCustomKeys實例方法來批量添加鍵/值對:

Java

CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
.putString("string key", "string value")
.putString("string key 2", "string  value 2")
.putBoolean("boolean key", True)
.putBoolean("boolean key 2", False)
.putFloat("float key", 1.01)
.putFloat("float key 2", 2.02)
.build();

FirebaseCrashlytics.getInstance().setCustomKeys(keysAndValues);

Kotlin+KTX

對於 Kotlin,現有功能比使用CustomKeysAndValues構建器更簡單。

crashlytics.setCustomKeys {
  key("str_key", "hello")
  key("bool_key", true)
  key("int_key", 1)
  key("long_key", 1L)
  key("float_key", 1.0f)
  key("double_key", 1.0)
}

添加自定義日誌消息

要為導致崩潰的事件提供更多背景信息,您可以將自定義 Crashlytics 日誌添加到您的應用程序。 Crashlytics 將日誌與您的崩潰數據相關聯,並將它們顯示在Firebase 控制台的 Crashlytics 頁面中的日誌選項卡下。

使用log幫助查明問題。例如:

Java

FirebaseCrashlytics.getInstance().log("message");

Kotlin+KTX

Firebase.crashlytics.log("message")

設置用戶標識符

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

要將用戶 ID 添加到您的報告中,請以 ID 號、令牌或散列值的形式為每個用戶分配一個唯一標識符:

Java

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Kotlin+KTX

Firebase.crashlytics.setUserId("user123456789")

如果您在設置後需要清除用戶標識符,請將值重置為空白字符串。清除用戶標識符不會刪除現有的 Crashlytics 記錄。如果您需要刪除與用戶 ID 關聯的記錄,請聯繫 Firebase 支持

(僅限 Android NDK)將元數據添加到 NDK 崩潰報告

您可以選擇在 C++ 代碼中包含crashlytics.h標頭,以將元數據添加到 NDK 崩潰報告,例如自定義鍵自定義日誌用戶標識符。所有這些選項都在上面的這個頁面上進行了描述。

crashlytics.hFirebase Android SDK GitHub Repository中以僅標頭 C++ 庫的形式提供。

閱讀頭文件中的註釋以獲取有關使用 NDK C++ API 的說明。

報告非致命異常

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

使用recordException方法在應用程序的catch塊中記錄非致命異常。例如:

Java

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Kotlin+KTX

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

所有記錄的異常都在 Firebase 控制台中顯示為非致命問題。問題摘要包含您通常從崩潰中獲得的所有狀態信息,以及按 Android 版本和硬件設備分類的故障。

Crashlytics 在專用後台線程上處理異常,以盡量減少對您的應用程序的性能影響。為了減少用戶的網絡流量,Crashlytics 將記錄的異常批量處理在一起,並在應用下次啟動時發送。

啟用選擇加入報告

默認情況下,Crashlytics 會自動為您應用的所有用戶收集崩潰報告。為了讓用戶更好地控制他們發送的數據,您可以通過禁用自動報告並僅在您選擇在代碼中將數據發送到 Crashlytics 來啟用選擇報告:

  1. AndroidManifest.xml文件的application塊中,添加meta-data標籤以關閉自動收集:

    <meta-data
        android:name="firebase_crashlytics_collection_enabled"
        android:value="false" />
    
  2. 通過在運行時調用 Crashlytics 數據收集覆蓋來為選定用戶啟用收集。覆蓋值在您的應用程序啟動期間保持不變,因此 Crashlytics 可以自動收集報告。要選擇退出自動崩潰報告,請將false作為覆蓋值傳遞。當設置為false時,新值將在應用程序的下一次運行之前應用。

    Java

    FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

    Kotlin+KTX

    Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

管理崩潰洞察數據

Crash Insights 通過將匿名堆棧跟踪與來自其他 Firebase 應用的跟踪進行比較,並讓您知道您的問題是否屬於更大趨勢的一部分,從而幫助您解決問題。對於許多問題,Crash Insights 甚至提供資源來幫助您調試崩潰。

Crash Insights 使用匯總的崩潰數據來識別常見的穩定性趨勢。如果您不想共享應用的數據,可以從Firebase 控制台中 Crashlytics 問題列表頂部的Crash Insights菜單中選擇退出 Crash Insights。