自訂 Firebase Crashlytics 當機報告

iOS+ Android Flutter Unity

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

• 檢測應用程式，記錄自訂鍵、自訂記錄訊息和使用者 ID。

• 向 Crashlytics 回報例外狀況。

• 如果應用程式使用 Firebase SDK for Google Analytics，系統會自動取得麵包屑記錄。這些記錄檔可讓您瞭解使用者在應用程式中觸發 Crashlytics 收集的事件前，所執行的動作。

• 為使用者關閉自動當機報告功能，並啟用選擇加入回報功能。請注意，根據預設，Crashlytics 會自動收集所有應用程式使用者的當機報告。

新增自訂鍵

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

• 在Crashlytics資訊主頁中，您可以搜尋符合自訂鍵的問題。

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

注意： Crashlytics 最多支援 64 個鍵/值組合。達到這個門檻後，系統就不會儲存其他值。每個鍵/值組的大小上限為 1 KB。

使用 setCustomKey 執行個體方法設定鍵/值組合。請注意，setCustomKey 會針對 value 參數多載，以接受任何原始或 String 引數。例如：

Kotlin

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("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

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

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

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

將 CustomKeysAndValues 的執行個體傳遞至 setCustomKeys 執行個體方法，即可大量新增鍵/值組合：

Kotlin

如果是 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)
}

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

新增自訂記錄訊息

如要進一步瞭解導致當機的事件，可以在應用程式中加入自訂 Crashlytics 記錄檔。Crashlytics 會將記錄檔與當機資料建立關聯，並顯示在 Firebase 控制台的 Crashlytics 頁面中，位於「記錄檔」分頁下方。

注意： 為避免應用程式速度變慢，Crashlytics 會將記錄檔限制為 64 KB，且當工作階段的記錄檔超過該限制時，會刪除較舊的記錄項目。

使用 log 找出問題。例如：

Kotlin

Firebase.crashlytics.log("message")

Java

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

設定使用者 ID

如要診斷問題，瞭解哪些使用者遇到特定異常終止情況通常很有幫助。Crashlytics 包含在當機報告中匿名識別使用者的機制。

如要在報表中加入 User-ID，請為每位使用者指派專屬 ID，形式可以是 ID 號碼、權杖或雜湊值：

Kotlin

Firebase.crashlytics.setUserId("user123456789")

Java

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

如要在設定使用者 ID 後清除，請將值重設為空白字串。清除使用者 ID 不會移除現有記錄。Crashlytics如要刪除與使用者 ID 相關聯的記錄，請與 Firebase 支援團隊聯絡。

(僅限 Android NDK) 在 NDK 錯誤報告中新增中繼資料

您可以在 C++ 程式碼中視需要加入 crashlytics.h 標頭，將中繼資料新增至 NDK 異常終止報告，例如自訂鍵、自訂記錄、使用者 ID。如要瞭解所有這些選項，請參閱上方的頁面。

crashlytics.h 是 Firebase Android SDK GitHub 存放區中僅含標頭的 C++ 程式庫。

如要瞭解如何使用 NDK C++ API，請參閱標頭檔案中的註解。

納入 GWP-ASan 報告，對記憶體毀損問題進行偵錯

Crashlytics 可收集 GWP-ASan 報告，協助您對原生記憶體錯誤導致的當機事件進行偵錯。這類記憶體相關錯誤可能與應用程式內的記憶體毀損問題有關，而這類問題是造成應用程式安全漏洞的主要原因。

• 在Crashlytics 資訊主頁中點選問題詳細資料時，您可以在新的「記憶體堆疊追蹤」分頁中查看這項資料。

• 您也可以使用新的「GWP-ASan 報告」信號和篩選器，快速查看所有含有這項資料的問題。

如要取得 GWP-ASan 記憶體報告，請在應用程式中明確啟用 GWP-ASan，並使用 Crashlytics SDK for NDK v18.3.6 以上版本 (Firebase BoM v31.3.0 以上版本)。您可以使用 Android 文件中的原生程式碼範例，測試 GWP-ASan 設定。

回報非嚴重例外狀況

除了自動回報應用程式當機情形，Crashlytics 還可記錄非嚴重例外狀況，並在應用程式下次啟動時傳送給您。

注意： Crashlytics 只會儲存最近記錄的八項例外狀況。如果應用程式擲回超過八個例外狀況，較舊的例外狀況就會遺失。

使用 recordException 方法，在應用程式的 catch 區塊中記錄非嚴重例外狀況。例如：

Kotlin

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

Java

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

此外，您也可以將自訂鍵附加至特定非嚴重例外狀況。例如：

Kotlin

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e) {
        key("string key", "string value")
        key("boolean key", true)
        key("float key", Float.MAX_VALUE)
    }
    // handle your exception here
}

Java

try {
    methodThatThrows();
} catch (Exception e) {
    CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
            .putString("string key", "string value")
            .putBoolean("boolean key", true)
            .putFloat("float key", Float.MAX_VALUE)
            .build();
    FirebaseCrashlytics.getInstance().recordException(e, keysAndValues);
    // handle your exception here
}

警告： 請勿在例外狀況訊息中加入專屬值 (例如使用者 ID 或時間戳記)，請改用自訂鍵。直接新增值可能會導致多項問題，並造成 Crashlytics 限制應用程式中的回報錯誤。

所有記錄的例外狀況都會在 Firebase 控制台中顯示為不嚴重問題。 問題摘要包含您通常從當機取得的所有狀態資訊，以及依 Android 版本和硬體裝置分類的資訊。

Crashlytics 會在專屬背景執行緒上處理例外狀況，盡量減少對應用程式效能的影響。為減少使用者的網路流量，Crashlytics 會將記錄的例外狀況分批處理，並在下次啟動應用程式時傳送。

取得導覽標記記錄

導覽標記記錄可協助您進一步瞭解使用者與應用程式的互動情形，進而找出導致當機、一般錯誤或 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。

1. 在 AndroidManifest.xml 檔案的 application 區塊中，新增 meta-data 標記，關閉自動收集功能：

   <meta-data
       android:name="firebase_crashlytics_collection_enabled"
       android:value="false" />
   

2. 在執行階段呼叫 Crashlytics 資料收集覆寫，即可為特定使用者啟用收集功能。覆寫值會在應用程式的所有後續啟動中保留，因此 Crashlytics 可以自動為該使用者收集報表。

   Kotlin

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

   如果使用者之後選擇停用資料收集功能，您可以傳遞 false 做為覆寫值，系統會在使用者下次啟動應用程式時套用該值，並在該使用者後續啟動應用程式時持續套用。

注意： 為使用者停用資料收集功能後，Crashlytics 會將當機資訊儲存在裝置本機。如果隨後啟用資料收集功能，裝置上儲存的任何當機資訊都會傳送至 Crashlytics 進行處理。

管理當機深入分析資料

當機深入分析功能會比較您應用程式的匿名堆疊追蹤記錄與其他 Firebase 應用程式的追蹤記錄，並在您的問題屬於較大規模的趨勢時通知您，協助您解決問題。對於許多問題，當機情況深入分析甚至會提供資源，協助您偵錯當機問題。

當機深入分析會使用匯總當機資料，找出常見的穩定性趨勢。 如不想分享應用程式資料，可以前往 Firebase 管理中心，在Crashlytics問題清單頂端的「當機深入分析」選單中停用這項功能。

注意： 停用資料共用功能後，系統會一併移除問題的深入分析資料。變更最多可能需要 24 小時才會生效。