概要

Android の Error Tracking は、クラッシュ、例外、およびエラーを自動的にキャプチャすることで、モバイルアプリの健康状態を包括的に把握できます。この機能を使用すると、次のことができます。

リアルタイムでアプリの安定性を監視し、バージョン、デバイス、およびユーザーセグメント全体で即時クラッシュアラートとエラー率を追跡します。 難読化を解除されたスタックトレースと自動 ProGuard マッピングファイルのアップロードにより、問題の特定が容易になり、より迅速にデバッグできます。 クラッシュしやすい機能を特定し、エラートレンドを追跡し、ユーザー満足度を向上させるために修正の優先順位を付けることで、アプリの品質を向上させます。 集計された Android クラッシュダッシュボードおよび属性にアクセスします。 トレンド分析付きの難読化解除された Android クラッシュレポートを表示します。

Datadog Android SDK は、Android 5.0+ (API レベル 21) と Android TV をサポートします。

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

##セットアップ

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

ステップ 1 Android SDK を依存関係として宣言する

アプリケーションモジュールの build.gradle ファイルで ddsdkandroidrum と Gradle プラグイン を依存関係として宣言します。

buildscript {
    dependencies {
        classpath("com.datadoghq:dd-sdk-android-gradle-plugin:x.x.x")
    }
}
plugins {
    id("com.datadoghq.dd-sdk-android-gradle-plugin")
    //(...)
}
android {
    //(...)
}
dependencies {
    implementation "com.datadoghq:dd-sdk-android-rum:x.x.x" 
    //(...)
}

ステップ 2 UI でアプリケーションの詳細を指定する

1. [Errors] (エラー) > [Settings] (設定) > [Browser and Mobile] (ブラウザとモバイル) > [+ New Application] (+ 新しいアプリケーション) に移動します。
2. アプリケーションタイプとして android を選択し、新しいアプリケーション名を入力して一意の Datadog アプリケーション ID とクライアントトークンを生成します。
3. [Create Application] (アプリケーションの作成) をクリックします。

ステップ 3 アプリケーションのコンテキストで Datadog SDK を初期化する

####初期化スニペットの更新

初期化スニペットでは、環境名、サービス名、およびバージョン番号を設定します。以下の例では、APP_VARIANT_NAME はデータを生成するアプリケーションのバリアントを指定します。詳しくは、タグの使用方法 をご覧ください。

初期化中に、サンプルレート (RUM セッション) を設定し、GDPR 準拠のためのトラッキング同意を設定することもできます。ライブラリを初期化するには、その他の設定オプション を参照してください。

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
            clientToken = <CLIENT_TOKEN>,
            env = <ENV_NAME>,
            variant = <APP_VARIANT_NAME>
        ).build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.EU1)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.EU1)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.US3)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.US3)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.US5)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.US5)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.US1_FED)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.US1_FED)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.AP1)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.AP1)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val configuration = Configuration.Builder(
                clientToken = <CLIENT_TOKEN>,
                env = <ENV_NAME>,
                variant = <APP_VARIANT_NAME>
            )
            .useSite(DatadogSite.AP2)
            .build()
        Datadog.initialize(this, configuration, trackingConsent)
    }
}

public class SampleApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Configuration configuration =
                new Configuration.Builder(<CLIENT_TOKEN>, <ENV_NAME>, <APP_VARIANT_NAME>)
                        .useSite(DatadogSite.AP2)
                        .build();
        Datadog.initialize(this, configuration, trackingConsent);
    }
}

初期化の資格情報には、アプリケーションのバリアント名が必要で、BuildConfig.FLAVOR の値を使用します。バリアントを使用することで、SDK はアプリケーションから報告されたエラーを Gradle プラグインによってアップロードされたマッピングファイルに一致させることができます。バリアントがない場合、資格情報は空の文字列を使用します。

Gradle プラグインは、ビルド時に適切な ProGuard mapping.txt ファイルを自動的にアップロードするため、難読化解除されたエラースタックトレースを確認できます。詳しくは、マッピングファイルをアップロードする セクションをご覧ください。

機能の有効化によるデータ送信の開始

Android SDK を有効にしてデータの送信を開始するには:

val rumConfig = RumConfiguration.Builder(applicationId)
    .trackUserInteractions()
    .trackLongTasks(durationThreshold) // Not applicable to Error Tracking
    .useViewTrackingStrategy(strategy)
    .build()
Rum.enable(rumConfig)

RumConfiguration rumConfig = new RumConfiguration.Builder(applicationId)
    .trackUserInteractions()
    .trackLongTasks(durationThreshold) // Not applicable to Error Tracking
    .useViewTrackingStrategy(strategy)
    .build();
Rum.enable(rumConfig);

すべてのビュー (アクティビティ、フラグメントなど) の自動追跡を有効にするには、ViewTrackingStrategy を参照してください。

####Web ビューのインスツルメント化 (オプション)

Android アプリ で WebView を使用して Web コンテンツを表示している場合、それらをインスツルメントすることで、Web コンテンツ内で発生する JavaScript エラーやクラッシュを追跡できます。

Web ビューをインスツルメント化するには:

1. build.gradle ファイルで ddsdkandroidwebview を依存関係として宣言し、Gradle 依存関係を追加します。

   dependencies {
    implementation "com.datadoghq:dd-sdk-android-webview:<latest_version>"
   }
   

2. 特定の WebView インスタンスのトラッキングを有効にするには、トラッキングするホストのリストを提供します。

   WebViewTracking.enable(webView, hosts)
   

詳細については、Web ビュー追跡 を参照してください。

ステップ 4 NDK クラッシュレポートを追加する

Android アプリが Android NDK (Native Development Kit) を通じてネイティブコード (C/C++) を使用している場合、このネイティブコードで発生するクラッシュを追跡できます。ネイティブコードは、パフォーマンスが重要視される操作、画像処理、または既存の C/C++ ライブラリを再利用する際に使用されることがよくあります。

NDK クラッシュレポートがないと、ネイティブコードでのクラッシュはエラートラッキングに表示されず、アプリケーションのこの部分の問題をデバッグするのが難しくなります。

NDK クラッシュレポートを有効にするには、Datadog NDK プラグインを使用します。

1. build.gradle ファイルでライブラリを依存関係として宣言して、Gradle 依存関係を追加します。

    dependencies {
        implementation("com.datadoghq:dd-sdk-android-ndk:x.x.x")
        //(...)
    }
   

2. SDK の初期化後に NDK のクラッシュの収集を有効にします。

   NdkCrashReports.enable()
   

ステップ 5 ANR レポートを追加する

「Application Not Responding」(ANR) は、アプリケーションが長時間応答しない場合に発生する Android 固有のエラーです。アプリケーションの応答性の問題を監視するために、RUM 設定に ANR レポートを追加できます。

ANR レポートを有効にするには、次の内容を RUM 設定に追加します。

val rumConfig = RumConfiguration.Builder(applicationId)
    .trackUserInteractions()
    .trackLongTasks(durationThreshold)
    .trackNonFatalAnrs(true) // Enable non-fatal ANR reporting
    .useViewTrackingStrategy(strategy)
    .build()
Rum.enable(rumConfig)

RumConfiguration rumConfig = new RumConfiguration.Builder(applicationId)
    .trackUserInteractions()
    .trackLongTasks(durationThreshold)
    .trackNonFatalAnrs(true) // Enable non-fatal ANR reporting
    .useViewTrackingStrategy(strategy)
    .build();
Rum.enable(rumConfig);

ANR は SDK を通じてのみ報告されます (ログを通じては報告されません)。

####致命的な ANR の報告 致命的な ANR はクラッシュにつながります。アプリケーションが応答しなくなると、Android OS にポップアップダイアログが表示され、ユーザーはポップアップからアプリを強制終了することができます。

Error Tracking ページでは、致命的な ANR は類似性に基づいてグループ化され、その結果、複数の 個別の問題 が作成されることがあります。 デフォルトでは、Datadog は ApplicationExitInfo API (Android 30+ から利用可能) を通じて致命的な ANR を検知し、アプリの次回起動時に読み取ることができます。 Android 29 以下 では、致命的な ANR の報告はできません。

致命的でない ANR の報告

致命的でない ANR は、アプリケーションの終了 (クラッシュ) につながった場合もあれば、つながっていない場合もあります。

Error Tracking ページでは、致命的でない ANR は、そのノイズのレベルのため、単一の問題にグループ化されます。 デフォルトでは、Android 30+ における致命的でない ANR の報告は、致命的な ANR に対してノイズが多すぎるため、無効になっています。しかし、Android 29 およびそれ以下のバージョンでは、致命的な ANR を報告できないため、致命的でない ANR の報告はデフォルトで 有効 になっています。

どの Android バージョンでも、SDK の初期化時に trackNonFatalAnrs を true または false に設定することで、致命的でない ANR の報告のデフォルト設定をオーバーライドすることができます。

ステップ 6 難読化解除されたスタックトレースを取得する

Android アプリが本番用にビルドする際、通常はアプリのサイズ削減と知的財産の保護のために ProGuard または R8 でコードが難読化されます。難読化により、クラッシュレポートのスタックトレースは読み取れなくなり、a.b.c() のような意味のないクラス名やメソッド名が表示され、com.example.MyClass.myMethod() のような本来の名前が表示されなくなります。

デバッグ用にこれらのスタックトレースを読みやすくするには、マッピングファイルを Datadog にアップロードする必要があります。これらのファイルには、難読化されたコードと元のコードとのマッピングが含まれており、Datadog がエラーレポート内のスタックトレースを自動的に難読化を解除できるようにします。

####仕組み

Datadog は、各ビルドに対して生成された一意のビルド ID を使用して、スタックトレースを正しいマッピングファイルと自動的に一致させます。これによって、次のことが確実にできるようになります。

スタックトレースは、アップロードされた時期に関係なく、常に正しいマッピングファイルで難読化が解除されます。 本番前のビルドまたは本番用のビルド中にマッピングファイルをアップロードすることができます。 このプロセスは、異なるビルドバリアントや環境間でシームレスに機能します。

マッチングプロセスは、ご使用の Android Gradle プラグイン のバージョンによって異なります。

バージョン 1.13.0 以上：build_id フィールドを使用します (Datadog Android SDK 2.8.0 以降が必要です) 古いバージョン: service、version、および variant フィールドの組み合わせを使用します。

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

Android Gradle プラグインにより、マッピングファイルのアップロードプロセスは自動化されます。設定後、アプリをビルドするときに、各ビルドバリアントに適切な ProGuard/R8 マッピングファイルを自動的にアップロードします。

注: マッピングファイルを再アップロードしても、バージョンに変更がない場合は既存のものをオーバーライドしません。ファイルサイズの制限やその他の制約については、制限事項 セクションを参照してください。

####アップロードタスクの実行

プラグインを設定した後、Gradle タスクを実行して、Proguard/R8 マッピングファイルと NDK シンボルファイルを Datadog にアップロードします。

./gradlew uploadMappingRelease
./gradlew uploadNdkSymbolFilesRelease

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

####アップロードされたマッピングファイルの一覧

すべてのアップロード済みシンボルを表示するには、RUM Debug Symbols ページを参照してください。

##高度なエラートラッキング機能

val rumConfig = RumConfiguration.Builder(applicationId)
        // Here 75% of the RUM sessions are sent to Datadog
        .setSessionSampleRate(75.0f)
        .build()
Rum.enable(rumConfig)

val tracedHostsWithHeaderType = mapOf(
    "example.com" to setOf(
        TracingHeaderType.DATADOG,
        TracingHeaderType.TRACECONTEXT),
    "example.eu" to setOf(
        TracingHeaderType.DATADOG,
        TracingHeaderType.TRACECONTEXT))
val okHttpClient = OkHttpClient.Builder()
    .addInterceptor(DatadogInterceptor.Builder(tracedHostsWithHeaderType).build())
    .build()

Map<String, Set<TracingHeaderType>> tracedHostsWithHeaderType = new HashMap<>();
Set<TracingHeaderType> datadogAndW3HeadersTypes = new HashSet<>(Arrays.asList(TracingHeaderType.DATADOG, TracingHeaderType.TRACECONTEXT));
tracedHostsWithHeaderType.put("example.com", datadogAndW3HeadersTypes);
tracedHostsWithHeaderType.put("example.eu", datadogAndW3HeadersTypes);
OkHttpClient okHttpClient = new OkHttpClient.Builder()
    .addInterceptor(new DatadogInterceptor.Builder(tracedHostsWithHeaderType).build())
    .build();

val okHttpClient = OkHttpClient.Builder()
    .addNetworkInterceptor(DatadogInterceptor.Builder(tracedHostsWithHeaderType).build())
    .build()

OkHttpClient okHttpClient = new OkHttpClient.Builder()
    .addNetworkInterceptor(new DatadogInterceptor.Builder(tracedHostsWithHeaderType).build())
    .build();

.trackBackgroundEvents(true)

.trackBackgroundEvents(true)

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

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

制限事項

ファイルサイズ

マッピングファイル のサイズは 500 MB に制限されています。プロジェクトにこのサイズを超えるマッピングファイルがある場合、次のオプションのいずれかを使用してファイルサイズを減らします。

mappingFileTrimIndents オプションを true に設定します。これにより、ファイルサイズが平均 5% 減少します。 mappingFilePackagesAliases のマップを設定します。これにより、パッケージ名が短いエイリアスに置き換えられます。注意: Datadog のスタックトレースは元のパッケージ名の代わりに同じエイリアスを使用するため、サードパーティの依存関係にはこのオプションの利用が推奨されます。

datadog {
    mappingFileTrimIndents = true
    mappingFilePackageAliases = mapOf(
        "kotlinx.coroutines" to "kx.cor",
        "com.google.android.material" to "material",
        "com.google.gson" to "gson",
        "com.squareup.picasso" to "picasso"
    )
}

###コレクション RUM クラッシュレポートの動作を Android で確認する際は、以下の点を考慮してください。

クラッシュは SDK が初期化された後にのみ検出できます。このため、アプリケーションの onCreate メソッド内で SDK をできるだけ早く初期化することをお勧めします。 RUM クラッシュは RUM ビューに関連付ける必要があります。ビューが表示される前 (通常は onResume 状態のアクティビティまたはフラグメント) にクラッシュが発生した場合や、エンドユーザーがアプリをバックグラウンドに送信した後にクラッシュが発生した場合、クラッシュはミュートされ、収集のために報告されません。これに対応するために、trackBackgroundEvents() メソッド をRumConfiguration ビルダー内で使用します。 サンプリングされたセッションで発生したクラッシュのみが保持されます。セッションサンプリングレートが 100% でない場合、一部のクラッシュは報告されません。

##実装のテスト

Android のクラッシュレポートとエラー追跡の構成を確認するには、アプリケーションでクラッシュを発生させ、Datadog にエラーが表示されることを確認する必要があります。

実装をテストするには

1. Android エミュレーターまたは実機でアプリケーションを実行します。

2. エラーやクラッシュを含むコードを実行します。たとえば、以下のとおりです。

   fun onEvent() {
       throw RuntimeException("Crash the app")
   }
   

3. クラッシュが発生したら、アプリケーションを再起動し、Android SDK が エラートラッキング にクラッシュレポートをアップロードするのを待ちます。

##Kotlin 拡張機能

Closeable 拡張機能

Closeable インスタンスの使用状況を useMonitored メソッドで監視できます。発生したエラーが Datadog に報告され、その後リソースが閉じられます。

val closeable: Closeable = ...
closeable.useMonitored {
    // Your code here
}

###ローカルアセットをリソースとして追跡

getAssetAsRumResource 拡張メソッドを使用して、アセットへのアクセスを追跡できます。

val inputStream = context.getAssetAsRumResource(fileName)

getRawResAsRumResource 拡張機能メソッドを使うことで、ローカルリソースの使用状況を追跡することができます。

val inputStream = context.getRawResAsRumResource(id)

##参考資料

お役に立つドキュメント、リンクや記事:

フロントエンドの Error TrackingDOCUMENTATION ddsdkandroid のソースコードSOURCE CODE エラー追跡を開始するDOCUMENTATION エクスプローラーでエラー追跡データを視覚化するDOCUMENTATION