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

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

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

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

始める前に

まだ Firebase を Android プロジェクトに追加していない場合は追加します。Android アプリをお持ちでない場合は、サンプルアプリをダウンロードできます。
推奨: クラッシュに遭遇していないユーザー数の表示、パンくずリストのログ、ベロシティアラートなどの機能を利用するには、Firebase プロジェクトで Google アナリティクスを有効にする必要があります。
- 既存の Firebase プロジェクトで Google アナリティクスが有効になっていない場合は、Firebase コンソールで、 > [プロジェクトの設定] の [統合] タブで Google アナリティクスを有効にします。
- 新しい Firebase プロジェクトを作成する場合は、プロジェクトの作成ワークフローで Google アナリティクスを有効にします。

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

モジュール（アプリレベル）の Gradle ファイル（通常は <project>/<app-module>/build.gradle）に、Crashlytics NDK Android ライブラリの依存関係を追加します。ライブラリのバージョニングの制御には、Firebase Android BoM（部品構成表）を使用することをおすすめします。

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

Kotlin+KTX

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.0.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-ktx'
}

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

（代替方法）BoM を使用せずに Firebase ライブラリの依存関係を追加する

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:18.3.7'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.2.2'
}

Java

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.0.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 部品構成表を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

（代替方法）BoM を使用せずに Firebase ライブラリの依存関係を追加する

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

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:18.3.7'
    implementation 'com.google.firebase:firebase-analytics:21.2.2'
}

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

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

buildscript {
    repositories {
      // Make sure that you have the following two repositories
      google()  // Google's Maven repository
      mavenCentral()  // Maven Central repository
    }

    dependencies {
        ...
        classpath 'com.android.tools.build:gradle:7.2.0'

        // Make sure that you have the Google services Gradle plugin dependency
        classpath 'com.google.gms:google-services:4.3.15'

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

モジュール（アプリレベル）の Gradle ファイル（通常は <project>/<app-module>/build.gradle）に、Crashlytics Gradle プラグインを追加します。

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: ビルドに `firebaseCrashlytics` 拡張機能を追加する

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

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

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

ステップ 4: ネイティブシンボルの自動アップロードを設定する

NDK のクラッシュから読み取り可能なスタックトレースを生成するには、ネイティブバイナリ内のシンボルを Crashlytics に知らせる必要があります。Crashlytics Gradle プラグインには、このプロセスを自動化する uploadCrashlyticsSymbolFileBUILD_VARIANT タスクが含まれています。

自動シンボルアップロードのタスクにアクセスするには、モジュール（アプリレベル）の Gradle ファイルで nativeSymbolUploadEnabled が true に設定されていることを確認してください。
スタックトレースにメソッド名を含めるには、NDK ライブラリをビルドするたびに uploadCrashlyticsSymbolFileBUILD_VARIANT タスクを明示的に呼び出す必要があります。次に例を示します。
```
>./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT
```
NDK 用の Crashlytics SDK と Crashlytics Gradle プラグインは両方とも、ネイティブ共有オブジェクト内の GNU ビルド ID の存在に依存しています。

この ID の存在を確認するには、各バイナリに対して readelf -n を実行します。このビルド ID が存在しない場合は、ビルドシステムのフラグに -Wl,--build-id を追加することで問題を解決できます。

ステップ 5: 強制的にテストクラッシュを発生させて設定を完了する

Crashlytics の設定を完了し、Firebase コンソールの Crashlytics ダッシュボードで最初のデータを確認するには、強制的にテストクラッシュを発生させる必要があります。

強制的にテストクラッシュを発生させるためのコードをアプリに追加します。

アプリの 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));

アプリをビルドして実行します。
アプリの最初のクラッシュレポートを送信するために、強制的にテストクラッシュを発生させます。
1. テスト用のデバイスまたはエミュレータからアプリを開きます。
2. アプリ内で、上述のコードを使用して追加した [Test Crash] ボタンを押します。
3. アプリがクラッシュしたら再起動します。これにより、Firebase にクラッシュレポートが送信されます。
Firebase コンソールの Crashlytics ダッシュボードに移動して、テストクラッシュを確認します。

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

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

次のステップ

（推奨）GWP-ASan レポートを収集すると、ネイティブメモリエラーに起因するクラッシュのデバッグに役立つ情報が得られます。このようなメモリ関連のエラーは、アプリのセキュリティの脆弱性の主な原因である、アプリ内のメモリ破損に関連している可能性があります。この機能を使用するには、アプリで GWP-ASan を明示的に有効にするとともに、最新の Crashlytics SDK for NDK（v18.3.6 以降または Firebase BoM v31.3.0 以降）を使用してください。
クラッシュレポートの設定をカスタマイズするために、オプトインレポート、ログ、キー、非致命的なエラーの追跡を追加する。
Android アプリのクラッシュレポートを Crashlytics ダッシュボードから直接 Google Play トラックでフィルタリングできるように、Google Play と統合する。これにより、ダッシュボードで特定のビルドに注目できます。

トラブルシューティング

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

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

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

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

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

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

このオプションの手順を表示

標準的な Crashlytics シンボルのアップロードタスクは、CMake などの標準的な NDK ビルドツールを使用して、アプリモジュールの Gradle ビルドの一環としてネイティブライブラリをビルドすることを前提としています。

カスタマイズした NDK のビルドプロセスを Gradle 内で使用している場合、またはネイティブライブラリがライブラリ / 機能モジュール内でビルドされている場合、またはネイティブライブラリがサードパーティによって提供されている場合は、ストリップされていないライブラリへのパスを明示的に指定しなければならない場合があります。これを行うには、build.gradle ファイルの firebaseCrashlytics 拡張機能に unstrippedNativeLibsDir プロパティを追加します。

このページの前述のメインワークフローに記載されている次の初期タスクが完了していることを確認してください。
自動シンボルアップロードタスクでシンボル情報を検出できるように、モジュール（アプリレベル）の build.gradle ファイルに次の設定を追加します。
```
// ...

android {
    // ...
    buildTypes {
        release {
            firebaseCrashlytics {
                nativeSymbolUploadEnabled true
                unstrippedNativeLibsDir file("PATH/TO/UNSTRIPPED/DIRECTORY")
            }
        }
    }
}
```
Crashlytics プラグインは、.so 拡張子を含むネイティブライブラリを、指定したディレクトリ内で再帰的に検索します。Crashlytics は、そのようなすべてのライブラリからデバッグシンボルを抽出し、Firebase サーバーにアップロードします。

unstrippedNativeLibsDir プロパティで指定できる内容を以下に示します。
- org.gradle.api.Project#files(Object...) に使用できる任意の引数（java.lang.String、java.io.File、org.gradle.api.file.FileCollection など）
- 1 つのビルドフレーバー用の複数のディレクトリ。リストまたは FileCollection インスタンスを指定します。
最後に、強制的にテストクラッシュを発生させて Crashlytics の設定を完了し、Firebase コンソールの Crashlytics ダッシュボードで最初のデータを確認します。

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

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

Gradle 以外のビルドプロセスを使用する場合
ストリップされていないネイティブライブラリが提供されていて、Gradle ビルド中にアクセスできない場合

このオプションの手順を表示

このオプションでは、リリースビルドを作成する際や、Firebase コンソールでシンボリケートされたスタックトレースを表示するビルドを作成する際に、Firebase CLI コマンドを実行する必要があります。

このページの前述のメインワークフローに記載されている次の初期タスクが完了していることを確認してください。
1. Firebase コンソールで Crashlytics を有効にした。
2. Crashlytics SDK for NDK と Crashlytics Gradle プラグインを追加した。
このオプションでは、firebaseCrashlytics 拡張機能を追加したり、自動シンボルアップロードを設定したりする必要はありません。代わりに、Firebase CLI（以下の手順を参照）を使用して、シンボルファイルの生成とアップロードを行います。
シンボルをアップロードするための環境設定とプロジェクト設定を行います。
1. このページの手順に沿って Firebase CLI をインストールします。
  
  すでに CLI がインストールされている場合は、最新バージョンに更新してください。
2. （Android API レベル 30 以上を使用するアプリの場合のみ）アプリの AndroidManifest.xml テンプレートを更新して、ポインタのタグ付けを無効にします。
  1. [Android Player Settings] > [Publishing Settings] > [Build] > [Custom Main Manifest] チェックボックスをオンにします。
  2. Assets/Plugins/Android/AndroidManifest.xml にあるマニフェストテンプレートを開きます。
  3. アプリケーションタグに次の属性を追加します: <application android:allowNativeHeapPointerTagging="false" ... />
プロジェクトをビルドします。

シンボル情報をアップロードします。

ビルドが完了したら、次の Firebase CLI コマンドを実行して、Crashlytics 互換のシンボルファイルを生成し、Firebase サーバーにアップロードします。

firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/SYMBOLS

FIREBASE_APP_ID: Firebase Android アプリ ID（パッケージ名ではありません）
Firebase Android アプリ ID の例: 1:567383003300:android:17104a2ced0c9b9b
Firebase アプリ ID を確認する方法
次の 2 つの方法で Firebase アプリ ID を確認することができます。
- google-services.json ファイル内の mobilesdk_app_id の値がアプリ ID です。
- Firebase コンソールでプロジェクトの設定に移動します。下にスクロールして [マイアプリ] カードを表示し、目的の Firebase アプリをクリックしてアプリ ID を確認します。
PATH/TO/SYMBOLS: CLI によって生成されたシンボルファイルのパス
- Android Studio プロジェクトにエクスポートされた場合: PATH/TO/SYMBOLS はディレクトリです。Firebase CLI は、.so 拡張子を含むネイティブライブラリを、指定したディレクトリ内で再帰的に検索します。
- Unity 内で直接 APK をビルドした場合: PATH/TO/SYMBOLS は、ビルドが完了したときにプロジェクトのルートディレクトリに生成される、圧縮されたシンボルファイルのパスです（例: myproject/myapp-1.0-v100.symbols.zip）。

Firebase CLI コマンドでシンボルファイルの生成とアップロードを行う際に使用される高度なオプションを表示

フラグ	説明
`--generator=csym`	デフォルトの Breakpad ジェネレーターではなく、古い cSYM シンボルファイルジェネレーターを使用します。このオプションの使用は推奨されません。デフォルトの Breakpad シンボルファイルジェネレーターを使用することをおすすめします。
`--generator=breakpad`	Breakpad シンボルファイルジェネレーターを使用します。デフォルトのシンボルファイル生成は Breakpad です。このフラグは、ビルド構成に `symbolGenerator { csym() }` を追加したが、それをオーバーライドして Breakpad を使用する場合のみ使用します。
`--dry-run`	シンボルファイルを生成するがアップロードは行いません。このフラグは、送信されるファイルの内容を調べる場合に役立ちます。
`--debug`	追加のデバッグ情報が提供されます。

最後に、強制的にテストクラッシュを発生させて Crashlytics の設定を完了し、Firebase コンソールの Crashlytics ダッシュボードで最初のデータを確認します。

強制的にクラッシュを発生させる処理の中でアプリのビルドを行った後に、Firebase CLI の crashlytics:symbols:upload コマンドを実行して、シンボルファイルをアップロードしてください。

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

始める前に

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

Kotlin+KTX

Java

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

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

Kotlin+KTX

Java

ステップ 4: ネイティブ シンボルの自動アップロードを設定する

ステップ 5: 強制的にテスト クラッシュを発生させて設定を完了する

Kotlin+KTX

Java

次のステップ

トラブルシューティング

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

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

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

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

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

ステップ 4: ネイティブシンボルの自動アップロードを設定する

ステップ 5: 強制的にテストクラッシュを発生させて設定を完了する

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

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