自訂 Firebase Crashlytics 當機報告

iOS+ Android Flutter Unity

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

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

• 將例外狀況回報給 Crashlytics。

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

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

新增自訂鍵

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

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

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

注意： 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，請將值重設為空白字串。清除使用者 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，並使用 Crashlytics SDK for NDK v18.3.6 以上版本 (Firebase BoM v31.3.0 以上版本)，即可取得 GWP-ASan 記憶體報告。您可以使用 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
}

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

所有記錄的例外狀況都會在 Firebase 主控台中顯示為非致命問題。問題摘要包含您通常會從當機事件取得的所有狀態資訊，以及依 Android 版本和硬體裝置分類的詳細資料。

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

取得導覽標記記錄

導覽標記記錄可讓您進一步瞭解使用者與應用程式互動時，導致當機、非致命錯誤或 ANR 事件的情形。嘗試重現問題並進行偵錯時，這些記錄可能會很有幫助。

麵包屑記錄由 Google Analytics 提供支援，因此如要取得麵包屑記錄，您必須為 Firebase 專案啟用 Google Analytics，並將 Google Analytics 的 Firebase SDK 新增至應用程式。滿足這些需求後，您查看問題詳細資料時，系統就會在「Logs」分頁中，自動將麵包屑記錄與事件資料一併顯示。

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 可以自動收集報表。如要選擇不使用自動當機回報功能，請傳遞 false 做為覆寫值。設定為 false 時，新值會在下次執行應用程式時才套用。

   Kotlin

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

注意：如果您停用自動回報功能，請注意以下事項：

• 當使用者停用資料收集功能時，Crashlytics 會在裝置本機上儲存當機資訊。如果之後啟用資料收集功能，系統會將裝置上儲存的所有當機資訊傳送至 Crashlytics 進行處理。
• 啟用選擇性回報功能後，系統只能從明確選擇收集資料的使用者收集當機資訊。因此，Crashlytics 只會顯示這些選擇加入的使用者 (而非所有使用者) 的當機資訊，因此未受當機影響的指標 (例如未受當機影響的使用者和工作階段) 準確度會受到影響。也就是說，無當機指標的可靠度可能會降低，且較難反映應用程式的整體穩定性。

管理當機深入分析資料

當機深入分析功能會將您的去識別化堆疊追蹤與其他 Firebase 應用程式的追蹤記錄進行比較，協助您解決問題，並讓您瞭解問題是否屬於更廣泛的趨勢。針對許多問題，Crash Insights 甚至會提供資源，協助您偵錯當機情形。

Crash Insights 會使用匯總的當機資料，找出常見的穩定性趨勢。如果您不想分享應用程式資料，可以在 Firebase 控制台的 Crashlytics 問題清單頂端，透過「Crash Insights」選單選擇停用這項功能。

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