Android のクラッシュレポートとエラー追跡

概要

エラー追跡は、RUM Android SDK から収集されたエラーを処理します。

Android のクラッシュとエラー追跡を有効にすると、リアルユーザーモニタリングで包括的なクラッシュレポートとエラートレンドを取得できます。この機能により、以下にアクセスが可能になります。

  • 集計済みの Android クラッシュダッシュボードおよび属性
  • 難読化された Android クラッシュレポート
  • Android エラー追跡とトレンド分析

クラッシュレポートは Error Tracking に表示されます。

セットアップ

まだ Android SDK をインストールしていない場合は、アプリ内セットアップ手順に従うか、Android RUM セットアップドキュメントを参照してください。

  1. Gradle の依存関係に最新版の RUM Android SDK を追加します。
  2. SDK の初期化の際に、アプリケーションの envvariant を構成します。
  3. Gradle タスクを実行し、難読化されたスタックトレースにアクセスするために、Proguard/R8 マッピングファイルを Datadog にアップロードします。

任意のエラーについて、ファイルパス、行番号、関連するスタックトレースの各フレームのコードスニペットにアクセスすることができます。

マッピングファイルのアップロード

  1. 以下のコードスニペットを使用して、Android Gradle プラグインを Gradle プロジェクトに追加します。

    // In your app's build.gradle script
    plugins {
        id("com.datadoghq.dd-sdk-android-gradle-plugin") version "x.y.z"
    }
    
  2. Datadog 専用の API キーを作成し、環境変数として DD_API_KEY または DATADOG_API_KEY という名前でエクスポートします。また、プロジェクトのルートに datadog-ci.json ファイルがあれば、その中の apiKey プロパティから取得することも可能です。

  3. オプションとして、build.gradle スクリプトでプラグインを構成して、EU リージョンにファイルをアップロードするように構成します。

    datadog {
        site = "EU1"
    }
    
  4. 難読化された APK が構築されたらアップロードタスクを実行します。

    ./gradlew uploadMappingRelease
    

: プロジェクトで追加のフレーバーを使用している場合、プラグインは、難読化が有効になっている各バリアントのアップロードタスクを提供します。この場合、RUM Android SDK を適切なバリアント名で初期化します (必要な API はバージョン 1.8.0 以降で使用可能です)。

  1. 以下のコードスニペットを使用して、Android Gradle プラグインを Gradle プロジェクトに追加します。

    // In your app's build.gradle script
    plugins {
        id("com.datadoghq.dd-sdk-android-gradle-plugin") version "x.y.z"
    }
    
  2. Datadog 専用の API キーを作成し、環境変数として DD_API_KEY または DATADOG_API_KEY という名前でエクスポートします。また、プロジェクトのルートに datadog-ci.json ファイルがあれば、その中の apiKey プロパティから取得することも可能です。

  3. アプリの build.gradle スクリプトファイルで以下のスニペットを追加し、EU リージョンで使用するようプラグインを構成します。

    datadog {
        site = "EU1"
    }
    
  4. 難読化された APK が構築されたらアップロードタスクを実行します。

    ./gradlew uploadMappingRelease
    

: プロジェクトで追加のフレーバーを使用している場合、プラグインは、難読化が有効になっている各バリアントのアップロードタスクを提供します。この場合、RUM Android SDK を適切なバリアント名で初期化します (必要な API はバージョン 1.8.0 以降で使用可能です)。

プラグインコンフィギュレーションオプション

プラグイン拡張機能を介して構成できるプラグインプロパティがいくつかあります。複数のバリアントを使用している場合は、バリアントの特定のフレーバーにプロパティ値を設定できます。

例えば、fooBarRelease バリアントの場合、以下のような構成になります。

datadog {
    foo {
        versionName = "foo"
    }
    bar {
        versionName = "bar"
    }
    fooBar {
        versionName = "fooBar"
    }
}

このバリアントのタスク構成は、以下の順序で提供される 3 つのフレーバー構成のすべてからマージされます。

  1. bar
  2. foo
  3. fooBar

これにより、versionName プロパティの最終的な値は fooBar と解決されます。

プロパティ名説明
versionNameアプリケーションのバージョン名 (デフォルトでは build.gradle スクリプトの android ブロックで宣言されたバージョン)。
serviceNameアプリケーションのサービス名 (デフォルトでは build.gradle スクリプトの android ブロックで宣言されたアプリケーションのパッケージ名)。
siteデータをアップロードする Datadog サイト (US1、US3、US5、EU1、または US1_FED)。
remoteRepositoryUrlソースコードがデプロイされたリモートリポジトリの URL。これを指定しない場合、この値はタスクの実行時に Git コンフィギュレーションから解決されます。
checkProjectDependenciesこのプロパティは、Datadog Android SDK が依存関係に含まれているかどうかをプラグインがチェックするかどうかを制御します。チェックしない場合、“none” は無視され、“warn” は警告をログに記録し、“fail” はエラーでビルドに失敗します (デフォルト)。

CI/CD パイプラインとのインテグレーション

デフォルトでは、マッピングのアップロードタスクは、ビルドグラフの他のタスクから独立しています。マッピングのアップロードが必要な場合は、このタスクを手動で実行します。

CI/CD パイプラインでこのタスクを実行し、ビルドグラフの一部としてこのタスクが必要な場合、マッピングファイルが生成された後にアップロードタスクを実行するように設定できます。

例:

tasks["minify${variant}WithR8"].finalizedBy { tasks["uploadMapping${variant}"] }

その他の参考資料