Android でクラッシュを報告する

Firebase Crash Reporting は、アプリで発生したエラーの詳細レポートを作成します。エラーは類似したスタックトレースごとに「問題」としてグループ化され、ユーザーに与える影響の重大度で優先順位付けされます。自動レポートを受信するだけでなく、カスタムイベントをログに記録して、問題発生に至った過程を把握することもできます。

Crash Reporting を設定する

Android での Crash Reporting を設定するには、次の手順に沿って操作します。

まだ設定を行っていない場合は、Android プロジェクト用に Firebase を設定します。
Firebase コンソールでアプリを Firebase プロジェクトに追加します。
Crash Reporting の依存関係をアプリレベルの build.gradle ファイルに追加します。
```
implementation 'com.google.firebase:firebase-crash:16.2.1'
```

最初のエラーを作成する

Firebase Crash Reporting では、致命的なエラー（または捕捉されなかった例外）のレポートが自動的に生成されます。また、例外を捕捉すると同時に例外の発生も報告したいというケースについてもレポートを生成することができます。そのようなエラーを報告するには、次の手順に沿って操作します。

メインアクティビティに静的 report メソッドの呼び出しを追加します。
```
FirebaseCrash.report(new Exception("My first Android non-fatal error"));
```
アプリを起動します。
adb logcat または Android Studio のログで、Crash Reporting が有効になっていることを確認するメッセージを探します。
Firebase コンソールの Crash Reporting のセクションをチェックし、エラーを確認します。エラーが表示されるまでに 1～2 分ほどかかります。

カスタムログを作成する

Crash Reporting を使用して、エラーレポートや、オプションで logcat にカスタムイベントを記録できます。イベントのログを記録するけれども logcat には出力しないという場合、次の例のように引数として文字列を渡すだけで処理できます。

FirebaseCrash.log("Activity created");MainActivity.java

logcat 出力を作成する場合は、ログレベルとタグも指定する必要があります。

ProGuard ラベルを可読化する

ProGuard は、ProGuard で難読化した記号を元の名前にマッピングする mapping.txt ファイルを生成します。ProGuard を有効にしている場合、マッピングファイルをアップロードすると、可読化されたスタックトレースを Crash Reporting インターフェースに表示できます。

次に示すように、テストを目的として ProGuard をデバッグビルドタイプで設定してから、./gradlew assembleDebug コマンドを使用してビルドできます。

debug {
   minifyEnabled true
   proguardFiles getDefaultProguardFile('proguard-android.txt'),
     'proguard-rules.pro'
}

Gradle を使用して ProGuard マッピングファイルをアップロードする

可読化されたスタックトレースを Firebase コンソールで表示するには、Crash Reporting プラグインによって作成された Gradle タスクを使用して、ProGuard マッピングファイルを Firebase にアップロードできます。

Crash Reporting プラグインを構成するには:

Crash Reporting プラグインを含めるように、ルートレベルの build.gradle ファイルにルールを追加します。

    buildscript {
      repositories {
        jcenter()
        // ...
      }

      dependencies {
        // ...
        // For Android Studio 2.x, use firebase-plugins version 1.1.1
        classpath 'com.google.firebase:firebase-plugins:1.1.1'
        // For Android Studio 3.0, use firebase-plugins version 1.1.5
        //classpath 'com.google.firebase:firebase-plugins:1.1.5'
      }
    }

アプリプロジェクトの Gradle ファイル（通常は app/build.gradle）で、次の行を「ADD THIS」の下に追加し、Crash Reporting プラグインを有効化します。

    apply plugin: 'com.android.application'
    // ADD THIS
    apply plugin: 'com.google.firebase.firebase-crash'

    android {
      // ...
    }

    dependencies {
      // ...
    }

次に、サービスアカウントと秘密鍵を作成します。

アップロードを認証するためのサービスアカウントキーをダウンロードします。Firebase コンソールでプロジェクトを選択し、[新しい秘密鍵の生成] をクリックします。

注意: サービスアカウントファイルには秘密鍵が含まれているため、そのファイルをプロジェクトのソース管理に配置することは避ける必要があります（特にアプリがオープンソースである場合）。この鍵を所有しているユーザーは誰でもマッピングファイルをアップロードできるため、鍵を必要とするユーザーとのみ共有してください。

1 つのプロジェクトに対し鍵は 1 つだけなので、鍵を紛失しないようにしてください。新しい鍵を作ると、それまでにそのプロジェクトに対して作られた鍵はすべて破棄されます。
$HOME/.gradle/gradle.properties へのファイルパスを指定した FirebaseServiceAccountFilePath というプロパティを追加するか、-P フラグを使用してコマンドラインで別のパスを指定します。後で FirebaseServiceAccountFilePath プロパティを更新して、さまざまなサービスアカウントファイルでタスクを実行することができます。
別の方法としては、-P フラグを使用してコマンドラインでマッピングファイルのパスを指定し、次のようにプロパティを設定することもできます。
```
./gradlew -PFirebaseServiceAccountFilePath=/usr/ServiceAccount/MyApp-a287fsd34.json :app:firebaseUploadReleaseProguardMapping
```
APK の作成とマッピングファイルのアップロードを行う場合には、プロジェクトディレクトリで gradlew コマンドを実行します。次に例を示します。
```
./gradlew :app:firebaseUploadReleaseProguardMapping
```
アップロードタスクの正確な名前はビルドバリアントの名前によって違います（firebaseUpload<VariantName>ProguardMapping のパターンに従います）。可能性のあるアップロードタスク名の詳細なリストについては、次の gradlew コマンドを実行してください。
```
./gradlew :app:tasks
```
また、firebaseUploadArchivedProguardMapping タスクを使用して ProGuard マッピングファイルをアップロードするときに使用する Gradle プロパティを指定することもできます。次の例のように、このタスクを使用して FirebaseCrashMappingFilePath、FirebaseCrashVersionCode、FirebaseCrashPackageName に Gradle プロパティを指定できます。
```
FirebaseCrashMappingFilePath=path/to/mapping/file
FirebaseCrashVersionCode=2
FirebaseCrashPackageName=example.package.name
```
この例では、プロジェクトのモジュールフォルダにあるデフォルトの google-services.json（通常は app/）を使用します。google-services.json ファイルを使用しない場合には、FirebaseCrashApiKey と FirebaseCrashAppId の両方に Gradle プロパティを指定する必要があります。

マルチ APK をビルドするアプリの操作

プラグインは、マルチ APK サポートを活用するアプリケーションに対しても有効です。各ビルドバリアントのタスクについては、そのバリアントのすべての APK のマッピングファイルがアップロードされます。

たとえば、次の Gradle の例に示すように、fullRelease という名前のビルドバリアントと、app-full-armeabi-v7a-release.apk や app-full-armeabi-release.apk などのマルチ APK によってさまざまなアーキテクチャをサポートしているとします。

    productFlavors {
        full {
            applicationId "com.google.firebase.sample.testapp"
            versionName "1.0-full"
        }
    }

    splits {
        abi {
            enable true
            reset()
            include 'armeabi', 'armeabi-v7a'
            universalApk true
        }
    }

./gradlew :app:firebaseUploadReleaseProguardMapping タスクを実行すると、app-armeabi-v7a-release.apk と app-armeabi-release.apk の ProGuard マッピングファイルがサーバーにアップロードされます。これらのアップロードに対して、次のような出力がコンソールに表示されます。

Successfully uploaded proguard mapping file for app fullArmeabiRelease with versionCode: 1!
Successfully uploaded proguard mapping file for app fullArmeabi-v7aRelease with versionCode: 2!

ProGuard マッピングファイルを手動でアップロードする

別の方法として、Crash Reporting を参照して [マッピングファイル] タブを選択することで、mapping.txt ファイルを Firebase コンソールに手動でアップロードすることもできます。

アップロードするファイルは次のようなファイルパスにあります。ただし、このパスはアプリごとに異なります。

<project root>/<module name>/build/outputs/mapping/<build type>/<appname>-proguard-mapping.txt

次に例を示します。

app/build/outputs/mapping/debug/app-proguard-mapping.txt

既知の問題

Android Studio 3.0 で Crash Reporting プラグインバージョン 1.1.0 または 1.1.1 を使用している場合、以下のエラーが発生します。アプリのルートレベルの build.gradle ファイルで、プラグインバージョン 1.1.5 を指定して使用してください。

Cannot create tasks to upload ProGuard Mapping File.java.lang.IllegalStateException: Resolving configuration 'androidTestAnnotationProcessor' directly is not allowed

次のステップ

新しい問題や回帰が報告されたときのメールアラートを設定する方法については、メールアラートの設定をご覧ください。
GitHub で Crash Reporting Android コードサンプルを確認して実行します。

Apr	MAY	Jun
	14
2018	2019	2020