Firebase Crashlytics を使ってみる

このクイックスタートでは、Firebase コンソールで包括的なクラッシュ レポートを表示できるよう、Firebase Crashlytics SDK を使用してアプリに Firebase Crashlytics を設定する方法について説明します。Android 向け Crashlytics では、クラッシュ、非致命的なエラー、「アプリケーション応答なし」（ANR）のエラーに関するレポートが生成されます。

Crashlytics を設定するには、Firebase コンソールと IDE の両方でタスク（Firebase 構成ファイルと Crashlytics SDK の追加など）を行う必要があります。設定を完了するには、強制的にテスト クラッシュを発生させて、最初のクラッシュ レポートを Firebase に送信する必要があります。

始める前に

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

2. 推奨: パンくずリストのログを自動的に取得して、クラッシュ イベント、非致命的イベント、ANR イベントに至るまでのユーザー操作を把握するには、Firebase プロジェクトで Google Analytics を有効にする必要があります。

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

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

3. アプリが次の最小バージョン要件を満たしていることを確認します。

   • Gradle 8.0
   • Android Gradle プラグイン 8.1.0
   • Google サービス Gradle プラグイン 4.4.1

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

パンくずリストのログを利用するには、Google Analytics 用の Firebase SDK もアプリに追加します。Firebase プロジェクトで Google アナリティクスが有効になっていることを確認してください。

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

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

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

dependencies {
    // Add the dependencies for the Crashlytics and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics:19.2.1")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

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

1. ルートレベル（プロジェクト レベル）の Gradle ファイル（<project>/build.gradle.kts または <project>/build.gradle）で、Crashlytics Gradle プラグインを plugins ブロックに追加します。

   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 の設定を完了し、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. アプリ内で、上述のコードを使用して追加した [Test Crash] ボタンを押します。

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

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

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

これで完了です。Crashlytics がアプリのクラッシュ、非致命的なエラー、ANR をモニタリングするようになりました。すべてのレポートと統計情報を参照して調査するには、Crashlytics ダッシュボードにアクセスします。

次のステップ

• クラッシュ レポートの設定をカスタマイズするために、オプトイン レポート、ログ、キー、非致命的なエラーの追跡を追加する。

• Android アプリのクラッシュ レポートを Crashlytics ダッシュボードから直接 Google Play トラックでフィルタリングできるように、Google Play と統合する。これにより、ダッシュボードで特定のビルドに注目できます。

• Android Studio で Crashlytics データを表示してフィルタする。
  • Android Studio の App Quality Insights（AQI）ウィンドウを使用すると、コードとともに Crashlytics データを表示できます。Crashlytics ダッシュボードと IDE 間を行き来することなく、問い合わせが多い問題のデバッグを開始できます。
  • Android Studio のドキュメントで AQI ウィンドウの使用方法をご覧ください。
  • ご意見をお聞かせください。AQI ウィンドウに関するフィードバックがありましたら、バグレポートを提出してください。