取得 Android NDK 當機報告

如果您的 Android 應用程式包含原生資料庫， 您可以針對原生程式碼啟用完整堆疊追蹤和詳細當機報告 透過 Firebase Crashlytics 對應用程式版本進行一些微幅更新 此外還會從 0 自動調整資源配置 您完全不必調整資源調度設定

本指南將說明如何使用 Firebase Crashlytics NDK 適用的 SDK。

瞭解如何開始使用 Crashlytics 在 Unity 中 請參閱 Unity 入門指南。

事前準備

  1. 如果您尚未在 Android 中新增 Firebase，請先完成這項作業。 專案。如果您沒有 Android 應用程式，請下載 範例應用程式。

  2. 建議：自動取得 導覽標記記錄 瞭解引發當機、一般錯誤或 ANR 事件的使用者動作 您必須在 Firebase 專案中啟用 Google Analytics。

    • 如果現有的 Firebase 專案沒有Google Analytics 啟用 Google Analytics，您可以前往 使用者介面的「整合」分頁 >專案設定 Firebase)。

    • 如要建立新的 Firebase 專案，請啟用「Google Analytics」 專案建立流程

  3. 確認應用程式符合下列「最低」需求版本：

    • Gradle 8.0
    • Android Gradle 外掛程式 8.1.0 版
    • Google 服務 Gradle 外掛程式 4.4.1 版

步驟 1：將 CrashlyticsNDK 適用的 SDK 新增至應用程式

在模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle)、 為 Android 的 Crashlytics NDK 程式庫新增依附元件。建議您使用 Firebase Android BoM敬上 管理程式庫版本管理

為透過 Crashlytics 獲得最佳體驗，建議你 正在啟用 Google Analytics ，然後將 Google Analytics 專用 Firebase SDK 加進應用程式。 

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.2.0"))

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk")
    implementation("com.google.firebase:firebase-analytics")
}

只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。

(替代做法) 新增 Firebase 程式庫依附元件，「不使用」 BoM

如果選擇不使用 Firebase BoM，請指定各個 Firebase 程式庫版本 都屬於依附元件行

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您 建議使用 BoM 管理程式庫版本，確保所有版本 相容。 

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk:19.0.3")
    implementation("com.google.firebase:firebase-analytics:22.1.0")
}
敬上 在尋找 Kotlin 專用的程式庫模組嗎？距離開始還有 2023 年 10 月 (Firebase BoM 32.5.0)，Kotlin 和 Java 開發人員皆可 依附於主要程式庫模組 (詳情請參閱 這項計畫的常見問題)。

步驟 2：在應用程式中加入 Crashlytics Gradle 外掛程式

  1. 在您的根層級 (專案層級) Gradle 檔案 (<project>/build.gradle.kts 或 <project>/build.gradle)，請將 plugins 區塊的 Crashlytics Gradle 外掛程式：

    Kotlin 

    plugins {
    // Make sure that you have the AGP plugin 8.1+ dependency
    id("com.android.application") version "8.1.4" apply false
    // ...

    // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
    id("com.google.gms.google-services") version "4.4.2" apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id("com.google.firebase.crashlytics") version "3.0.2" apply false
}

    Groovy 

    plugins {
    // Make sure that you have the AGP plugin 8.1+ dependency
    id 'com.android.application' version '8.1.4' apply false
    // ...

    // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
    id 'com.google.gms.google-services' version '4.4.2' apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id 'com.google.firebase.crashlytics' version '3.0.2' apply false
}

  2. 在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，新增 Crashlytics Gradle 外掛程式：

    Kotlin 

    plugins {
  id("com.android.application")
  // ...

  // Make sure that you have the Google services Gradle plugin
  id("com.google.gms.google-services")

  // Add the Crashlytics Gradle plugin
  id("com.google.firebase.crashlytics")
}

    Groovy 

    plugins {
  id 'com.android.application'
  // ...

  // Make sure that you have the Google services Gradle plugin
  id 'com.google.gms.google-services'

  // Add the Crashlytics Gradle plugin
  id 'com.google.firebase.crashlytics'
}

步驟 3：在版本中加入 Crashlytics 擴充功能

在模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle)，請設定 Crashlytics 擴充功能。

Kotlin 

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
  // ...
  buildTypes {
      getByName("release") {
          // Add this extension
          configure<CrashlyticsExtension> {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled = true
          }
      }
  }
}

Groovy 

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

步驟 4：設定原生符號的自動上傳功能

如要從 NDK 當機中產生可讀取的堆疊追蹤，Crashlytics 必須瞭解 有關原生二進位檔中的符號Crashlytics Gradle 外掛程式 包含uploadCrashlyticsSymbolFileBUILD_VARIANT 自動執行這項程序

  1. 您是否能存取自動上傳符號的工作 將模組中的 nativeSymbolUploadEnabled 設為 true (應用程式層級) Gradle 檔案。

  2. 如要讓方法名稱顯示在堆疊追蹤中，您必須在每次建構 NDK 程式庫後，明確叫用 uploadCrashlyticsSymbolFileBUILD_VARIANT 工作。例如：

    >./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT

  3. NDK 適用的 Crashlytics SDK 和 Crashlytics Gradle 外掛程式 取決於原生共用物件中是否有 GNU 版本 ID。

    如要驗證這個 ID 的存在，請執行以下指令： 每個二進位檔的 readelf -n。如果沒有版本 ID，請將 -Wl,--build-id 新增至建構系統的標記，以便修正問題。

步驟 5：強制測試當機以完成設定

您需要強制測試當機，才能完成設定 Crashlytics，並在 Firebase 控制台的 Crashlytics 資訊主頁中看見初始資料。

  1. 在應用程式中加入可用於強制測試當機的程式碼。

    您可以在應用程式的 MainActivity 中使用下列程式碼新增按鈕 會導致當機。按鈕標示為「Test Crash」。

    Kotlin+KTX 

    val crashButton = Button(this)
crashButton.text = "Test Crash"
crashButton.setOnClickListener {
   throw RuntimeException("Test Crash") // Force a crash
}

addContentView(crashButton, ViewGroup.LayoutParams(
       ViewGroup.LayoutParams.MATCH_PARENT,
       ViewGroup.LayoutParams.WRAP_CONTENT))

    Java 

    Button crashButton = new Button(this);
crashButton.setText("Test Crash");
crashButton.setOnClickListener(new View.OnClickListener() {
   public void onClick(View view) {
       throw new RuntimeException("Test Crash"); // Force a crash
   }
});

addContentView(crashButton, new ViewGroup.LayoutParams(
       ViewGroup.LayoutParams.MATCH_PARENT,
       ViewGroup.LayoutParams.WRAP_CONTENT));

  2. 建構並執行應用程式。

  3. 強制測試當機，以便傳送應用程式的第一份當機報告：

    1. 在測試裝置或模擬器中開啟應用程式。

    2. 在應用程式中，按下「測試當機」透過程式碼新增的按鈕 。

    3. 應用程式當機後，請重新啟動，讓應用程式傳送當機事件 向 Firebase 回報

  4. 前往 Firebase 控制台的 Crashlytics 資訊主頁，查看測試異常終止情形。

    重新整理控制台後，如未發現測試當機 五分鐘後 啟用偵錯記錄功能 查看應用程式是否傳送當機報告。


大功告成！「Crashlytics」正在監控應用程式的當機情形，而你 您可以查看及調查當機報告和統計資料， Crashlytics資訊主頁。

後續步驟

  • (建議) 如何對原生記憶體錯誤造成的當機問題進行偵錯 收集 GWP-ASan 報告。 這些記憶體相關錯誤可與 這是造成應用程式安全漏洞的主要原因。 如要利用這項偵錯功能，請確認您的應用程式具有 已明確啟用 GWP-ASan 並使用最新的 Crashlytics SDK for NDK (18.3.6 以上版本或 Firebase BoM v31.3.0+)。

  • 自訂 當機報告設定，新增選擇使用報告、紀錄、鍵 不嚴重的錯誤追蹤

  • 與 Google Play 整合，讓 可以直接依下列路徑篩選 Android 應用程式的當機報告：Google Play Crashlytics資訊主頁。如此一來，您就能更專注於特定版本上的資訊主頁。

疑難排解

如果您在 Firebase 主控台和 logcat 中看到不同的堆疊追蹤，請參閱疑難排解指南。


替代符號上傳方式

上述頁面中的主要工作流程適用於標準 Gradle 版本。 不過，有些應用程式會使用不同的設定或工具 (例如 Gradle 以外的建構程序)。在這種情況下，可用的選項可能是 可協助你成功上傳符號

選項：上傳程式庫模組和外部依附元件的符號

這個選項在下列情況下相當實用：

  • 如果您在 Gradle 中使用自訂 NDK 建構程序
  • 如果原生資料庫是在程式庫/功能模組中建構，或由第三方提供
  • 如果自動符號上傳工作 或資訊主頁顯示無符號的當機問題

選項：上傳非 Gradle 版本或無法存取且未移除的原生資料庫的符號

這個選項在下列情況下相當實用：

  • 如果使用 Gradle 以外的建構程序

  • 如果系統以 您無法在 Gradle 建構期間存取這些內容