自訂 Firebase Crashlytics 當機報告


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

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

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

回報例外狀況

回報已偵測到的例外狀況

如果您有預期的例外狀況，可以讓 Crashlytics SDK 將這些例外狀況回報為非致命事件。這些事件會記錄在裝置上，然後隨下一個致命事件報告或使用者重新啟動遊戲時傳送。

您可以使用下列方法在 C# 中記錄例外狀況：

Crashlytics.LogException(Exception ex);

您可以在遊戲的 try/catch 區塊中記錄預期的例外狀況：

try {
    myMethodThatThrows();
} catch (Exception e) {
   Crashlytics.LogException(e);
   // handle your exception here!
}

回報未偵測到的例外狀況

對於不會導致遊戲當機的未偵測到的例外狀況 (例如遊戲邏輯中未偵測到的 C# 例外狀況)，您可以將 Crashlytics.ReportUncaughtExceptionsAsFatal 屬性設為 true，並在 在 Unity 專案中初始化 Crashlytics 時，讓 Crashlytics SDK 將這些例外狀況回報為嚴重事件。這些事件會即時回報至 Crashlytics，使用者不必重新啟動遊戲。

將這些未偵測到的例外狀況回報為嚴重事件，表示這些事件會計入您未受當機情況影響的使用者統計資料，且會算做當機風險驟升快訊的一部分。

請注意，原生異常一律會回報為嚴重事件。這些事件會在裝置上記錄，並在使用者重新啟動遊戲時傳送。

void Start() {
    // Since there is no try-block surrounding this call, if an exception is thrown,
    // it is considered unexpected.
    // Setting `Crashlytics.ReportUncaughtExceptionsAsFatal = true`
    // will ensure that such cases are reported as fatals.
    thirdPartyMethodThatMayThrow();
}

加入 GWP-ASan 報告，以便偵錯記憶體毀損問題

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

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

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

如果應用程式使用最新的 Unity 版 Crashlytics SDK (10.7.0 以上版本)，且已明確啟用 GWP-ASan (需要修改 Android 應用程式資訊清單)，您就能取得 GWP-ASan 記憶體報告。如果應用程式中有任何 C++ 程式碼，您可以使用 Android 說明文件中的原生程式碼範例，測試 GWP-ASan 設定。

新增自訂鍵

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

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

多次呼叫時，現有鍵的新值會更新值，且系統只會在記錄當機時擷取最新的值。

Crashlytics.SetCustomKey(string key, string value);

新增自訂記錄訊息

記錄的訊息會與當機資料相關聯，您在查看特定當機事件時，即可在 Firebase Crashlytics 資訊主頁中看到這些訊息。

Crashlytics.Log(string message);

設定使用者 ID

您可以使用 ID 編號、符記或雜湊值，以不洩漏或傳輸任何個人資訊的方式，明確識別應用程式的使用者。您也可以將值設為空白字串，藉此清除值。查看特定當機事件時，這個值會顯示在 Firebase Crashlytics 資訊主頁中。

Crashlytics.SetUserId(string identifier);

取得導覽標記記錄

導覽標記記錄可讓您進一步瞭解使用者與應用程式互動時，導致當機、非致命錯誤或 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，請在執行階段呼叫 Crashlytics 資料收集覆寫值。覆寫值會在應用程式啟動期間持續存在，因此 Crashlytics 可以自動收集報表。如要停用自動當機回報功能，請傳遞 false 做為覆寫值。將值設為 false 時，必須等到下次執行應用程式，新值才會套用。

Crashlytics.IsCrashlyticsCollectionEnabled = true

管理當機深入分析資料

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

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