Firebase Crashlytics を使ってみる

iOS+ Android Flutter Unity

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

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

始める前に

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

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

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

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

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

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

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

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

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

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

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

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

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

1. ルートレベル（プロジェクト レベル）の 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.14'
   
           // Add the dependency for the Crashlytics Gradle plugin
           classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.2'
       }
   }

2. モジュール（アプリレベル）の 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: 強制的にテスト クラッシュを発生させて設定を完了する

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

次のステップ

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

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

• Android Studio の [App Quality Insights] ウィンドウで、コードと一緒にスタック トレースとクラッシュ統計情報を表示する。このツールを使用すると、Crashlytics ダッシュボードと IDE を行き来することなく、主要な問題への対処を開始できます。
  • この機能には、Android Studio の最新の Canary バージョン - Electric Eel | 2022.1.1 からアクセスします。
  • この機能の使用方法については、Android Studio の新機能に関するドキュメントをご覧ください。
  • この Canary バージョンの機能について、ぜひご意見をお聞かせください。フィードバックがある場合や問題が発生した場合は、バグレポートをご提出ください。