Check out what’s new from Firebase at Google I/O 2022. Learn more

Android NDK クラッシュ レポートを取得する

Android アプリにネイティブ ライブラリが含まれている場合は、アプリのビルド構成を少し変更するだけで、Firebase Crashlytics でネイティブ コードの完全なスタック トレースを行い、詳細なクラッシュ レポートを作成できます。

このガイドでは、NDK 用の Firebase Crashlytics SDK を使用してクラッシュ レポートを構成する方法について説明します。

Unity プロジェクトで Crashlytics の使用を開始する方法については、Unity 向けのスタートガイドをご覧ください。

始める前に

  1. まだ Firebase を Android プロジェクトに追加していない場合は追加します。Android アプリをお持ちでない場合は、サンプルアプリをダウンロードできます。

  2. 推奨: クラッシュに遭遇していないユーザー数の表示、パンくずリストのログ、ベロシティ アラートなどの機能を利用するには、Firebase プロジェクトで Google アナリティクスを有効にする必要があります。

    • 既存の Firebase プロジェクトで Google アナリティクスが有効になっていない場合は、Firebase コンソールで、 > [プロジェクトの設定] の [統合] タブで Google アナリティクスを有効にします。

    • 新しい Firebase プロジェクトを作成する場合は、プロジェクトの作成ワークフローで Google アナリティクスを有効にします。

ステップ 1: NDK 用の Firebase Crashlytics SDK をアプリに追加する

Firebase Android BoM を使用して、モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）で Crashlytics NDK Android ライブラリの依存関係を宣言します。

Crashlytics でのエクスペリエンスを最適化するために、Firebase プロジェクトで Google アナリティクスを有効にして、Google アナリティクス用の Firebase SDK をアプリに追加することをおすすめします。

Java

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

    // Declare 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 ライブラリを使用します。

（別の方法）BoM を使用せずに Firebase ライブラリの依存関係を宣言する

Firebase BoM を使用しない場合は、依存関係の行でそれぞれの Firebase ライブラリのバージョンを指定する必要があります。

アプリで複数の Firebase ライブラリを使用する場合は、すべてのバージョンの互換性を確保するため、BoM を使用してライブラリのバージョンを管理することを強くおすすめします。 

dependencies {
    // Declare 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:18.2.10'
    implementation 'com.google.firebase:firebase-analytics:21.0.0'
}

Kotlin+KTX

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

    // Declare 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-ktx'
}

Firebase Android BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

（別の方法）BoM を使用せずに Firebase ライブラリの依存関係を宣言する

Firebase BoM を使用しない場合は、依存関係の行でそれぞれの Firebase ライブラリのバージョンを指定する必要があります。

アプリで複数の Firebase ライブラリを使用する場合は、すべてのバージョンの互換性を確保するため、BoM を使用してライブラリのバージョンを管理することを強くおすすめします。

dependencies {
    // Declare 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:18.2.10'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.0.0'
}

ステップ 2: アプリに Firebase Crashlytics プラグインを追加する

  1. プロジェクト レベルの build.gradle ファイルで、buildscript の依存関係として Crashlytics Gradle プラグインを追加します。

    buildscript {
    repositories {
        // Check that you have Google's Maven repository (if not, add it).
        google()
    }

    dependencies {
        // ...

        // Check that you have the Google services Gradle plugin v4.3.2 or later
        // (if not, add it).
        classpath 'com.google.gms:google-services:4.3.10'

        // Add the Crashlytics Gradle plugin
        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.8.1'
    }
}

allprojects {
    repositories {
        // Check that you have Google's Maven repository (if not, add it).
        google()
    }
}

  2. アプリレベルの build.gradle ファイルで、Crashlytics Gradle プラグインを適用します。

    apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services' // Google services Gradle plugin

// Apply the Crashlytics Gradle plugin
apply plugin: 'com.google.firebase.crashlytics'

ステップ 3: ビルドに firebaseCrashlytics 拡張機能を追加する

モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）に、firebaseCrashlytics 拡張機能を追加します。

Java

// ...

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
          }
      }
  }
}

Kotlin+KTX

// ...

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. 自動シンボル アップロードのタスクにアクセスするには、モジュール（アプリレベル）の Gradle ファイルで nativeSymbolUploadEnabled が true に設定されていることを確認してください。

  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」というラベルが付いています。

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

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

  2. アプリをビルドして実行します。

  3. アプリの最初のクラッシュ レポートを送信するために、強制的にテスト クラッシュを発生させます。

    1. テスト用のデバイスまたはエミュレータからアプリを開きます。

    2. アプリ内で、上述のコードを使用して追加した [Test Crash] ボタンを押します。

    3. アプリがクラッシュしたら再起動します。これにより、Firebase にクラッシュ レポートが送信されます。

  4. Firebase コンソールの Crashlytics ダッシュボードに移動して、テスト クラッシュを確認します。

    コンソールを更新し、5 分経過してもテスト クラッシュが表示されない場合は、デバッグ ロギングを有効にして、アプリがクラッシュ レポートを送信しているかどうかを確認してください。


これで完了です。これで Crashlytics がアプリのクラッシュをモニタリングするようになったため、Crashlytics ダッシュボードでクラッシュ レポートと統計情報を確認、調査できます。


シンボルをアップロードするための代替オプション

このページの前述のメイン ワークフローは、標準の Gradle ビルドに適用できます。ただし、アプリによっては、別の構成やツール（Gradle 以外のビルドプロセスなど）を使用する場合があります。そのような場合は、以下のオプションを使用してシンボルをアップロードできる可能性があります。

オプション: ライブラリ モジュールと外部依存関係のシンボルをアップロードする

このオプションは次のような場合に役立ちます。

  • カスタマイズした NDK ビルドプロセスを Gradle 内で使用する場合
  • ネイティブ ライブラリがライブラリ / 機能モジュール内でビルドされている場合、またはサードパーティによって提供されている場合
  • 自動シンボル アップロード タスクが失敗する場合、またはシンボリケートされていないクラッシュがダッシュボードに表示される場合

オプション: Gradle 以外のビルドのシンボル、またはストリップされておらずアクセスできないネイティブ ライブラリのシンボルをアップロードする

このオプションは次のような場合に役立ちます。

  • Gradle 以外のビルドプロセスを使用する場合

  • ストリップされていないネイティブ ライブラリが提供されていて、Gradle ビルド中にアクセスできない場合


トラブルシューティング

Firebase コンソールのスタック トレースと logcat のスタック トレースが一致しない場合は、トラブルシューティング ガイドをご覧ください。

次のステップ