自訂 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,讓 Crashlytics SDK 將其回報為「嚴重事件」,方法是在 Unity 專案中初始化 Crashlytics。這些事件會即時回報至 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,即可取得 GWP-ASan 記憶體報告 (需要修改 Android 應用程式資訊清單)。如果應用程式含有 C++ 程式碼,您可以使用 Android 說明文件中的原生程式碼範例範例測試 GWP-ASan 設定。

新增自訂鍵

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

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

如果多次呼叫,現有鍵的新值會更新值,且記錄當機時只會擷取最新的值。

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 新增至應用程式。符合這些規定後,系統就會在您查看問題詳細資料時,自動將導覽標記記錄與事件資料一併納入「記錄」分頁中。

Analytics SDK 會自動記錄 screen_view 事件,讓導覽標記記錄顯示當機、一般或 ANR 事件發生前瀏覽的畫面清單。screen_view 導覽標記記錄包含 firebase_screen_class 參數。

導覽標記記錄也會填入您在使用者工作階段中手動記錄的所有自訂事件,包括事件的參數資料。這項資料有助於顯示引發當機、一般錯誤或 ANR 事件的一系列使用者動作。

請注意,您可以控管 Google Analytics (分析) 資料的收集和使用方式,包括填入導覽標記記錄的資料。

啟用自選回報功能

根據預設,Crashlytics 會自動收集應用程式所有使用者的當機報告。您可以讓使用者選擇回報當機事件,進一步控管傳送的資料。

如果只要為所選使用者停用自動收集功能並初始化 Crashlytics,請在執行階段呼叫 Crashlytics 資料收集覆寫。覆寫值會在應用程式啟動後保留,以便 Crashlytics 自動收集報表。如要停用自動當機回報功能,請傳遞 false 做為覆寫值。如果設為 false,新的值必須等到應用程式下次執行後才會套用。

Crashlytics.IsCrashlyticsCollectionEnabled = true

管理當機深入分析資料

當機分析功能可將匿名堆疊追蹤與其他 Firebase 應用程式的追蹤記錄進行比較,讓您瞭解問題是否出在更大趨勢,進而解決問題。許多問題甚至會提供相關資源來協助偵錯。

當機深入分析會使用匯總的當機資料,找出常見的穩定性趨勢。 如果您不想分享應用程式的資料,可以在 Firebase 控制台的 Crashlytics 問題清單頂端,從「Crash Insights」選單選擇不採用 Crash Insights。