クイックスタート¶
このドキュメントでは、Android RUM SDK の最短の統合パスを提供し、最小限の手順で検証可能なデータ報告を実現することを目的としています。
前提条件¶
開始する前に、以下の準備を完了してください。
- リアルユーザーモニタリング(RUM) で Android アプリケーションを作成し、
RUM App IDを取得します。 - 報告先アドレスと認証方式を確認します。
- ローカル環境デプロイ:
datakitUrlを準備します。 - パブリックネットワーク DataWay:
datawayUrlとclientTokenを準備します。 - アプリケーションに
Applicationが存在することを確認するか、新規作成してAndroidManifest.xmlで宣言する準備をします。
統合手順¶
- Maven リポジトリを設定し、
ft-sdkを導入します。 - 必要に応じて
ft-plugin、ft-native、okhttpを導入します。 Application.onCreate()で SDK をインストールし、RUMを初期化します。同時にクラッシュ検出とフリーズ検出を有効にします。- ログ収集や分散型トレーシングが必要な場合は、
Log、Traceを初期化します。 - デバッグログを有効にし、ページを開くかネットワークリクエストをトリガーして、データが正常に報告されることを確認します。
Maven リポジトリ¶
ft-plugin と ft-sdk を同時に導入する場合、プラグインと AAR 依存関係のそれぞれに Maven リポジトリを設定する必要があります。具体的な Gradle 設定方法については、アプリケーション統合 を直接参照してください。
最小依存関係¶
// build.gradle
plugins {
id 'com.cloudcare.ft.mobile.sdk.tracker.plugin' version '[latest_version]'
}
// app/build.gradle
dependencies {
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
// JSON シリアライズ
implementation 'com.google.code.gson:gson:2.8.+'
// オプション、ネットワークリクエストの自動収集とリンクトレーシングの自動有効化に必要。最低互換バージョンは 3.12.+
implementation 'com.squareup.okhttp3:okhttp:4.+'
}
以下の機能が必要な場合は、対応する依存関係を追加してください。
ft-native:Native Crash の収集。okhttp:ネットワークリクエストの自動収集または Trace Header の自動注入に必要。
ft-pluginは、ページ、クリック、OkHttp リクエスト、WebView などのデータを自動収集するために使用されます。現在のプロジェクトが旧バージョンの AGP を使用している場合は、代わりにft-plugin-legacyを使用してください。完全な記述方法はアプリケーション統合を参照してください。
Application の宣言¶
プロジェクトにカスタム Application がまだない場合は、作成して AndroidManifest.xml で宣言してください。
最小初期化サンプル¶
public class DemoApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// ローカル環境デプロイの場合は FTSDKConfig.builder(datakitUrl) を使用
FTSDKConfig config = FTSDKConfig.builder(datawayUrl, clientToken);
config.setDebug(true);
FTSdk.install(config);
FTSdk.initRUMWithConfig(
new FTRUMConfig()
.setRumAppId(RUM_APP_ID)
.setEnableTraceUserView(true)
.setEnableTraceUserAction(true)
.setEnableTraceUserResource(true)
.setEnableTrackAppUIBlock(true)
.setEnableTrackAppCrash(true)
.setEnableTrackAppANR(true)
);
}
}
class DemoApplication : Application() {
override fun onCreate() {
super.onCreate()
// ローカル環境デプロイの場合は FTSDKConfig.builder(datakitUrl) を使用
val config = FTSDKConfig.builder(datawayUrl, clientToken)
config.setDebug(true)
FTSdk.install(config)
FTSdk.initRUMWithConfig(
FTRUMConfig()
.setRumAppId(RUM_APP_ID)
.setEnableTraceUserView(true)
.setEnableTraceUserAction(true)
.setEnableTraceUserResource(true)
.setEnableTrackAppUIBlock(true)
.setEnableTrackAppCrash(true)
.setEnableTrackAppANR(true)
)
}
}
上記のサンプルは最小限の RUM 統合を満たしており、クラッシュ検出とフリーズ検出がデフォルトで有効になります。ローカル環境デプロイを使用する場合は、
FTSDKConfig.builder(datawayUrl, clientToken)をFTSDKConfig.builder(datakitUrl)に置き換えてください。
オプション:Log と Trace の初期化¶
ログ収集や分散型トレーシングも必要な場合は、以下の初期化を追加できます。
FTSdk.initLogWithConfig(
FTLoggerConfig()
.setEnableCustomLog(true)
.setEnableLinkRUMData(true)
)
FTSdk.initTraceWithConfig(
FTTraceConfig()
.setEnableAutoTrace(true)
.setEnableLinkRUMData(true)
)
統合成功の確認¶
config.setDebug(true)を有効にしたまま、アプリケーションを実行します。- ページを開くか、
okhttpが統合されている環境でネットワークリクエストを実行します。 Logcatで[FT-SDK]を検索し、initRUMWithConfig completeやSync Successのようなログが表示されることを確認します。- Guance コンソールに戻り、アプリケーションに対応する RUM データが表示されていることを確認します。
次のステップ¶
- 完全なインストールと初期化の説明については、アプリケーション統合 を参照してください。
- すべての初期化パラメータの説明については、SDK 初期化 を参照してください。
- RUM、Log、Trace の詳細な設定については、RUM 設定、Log 設定、Trace 設定 を参照してください。
- WebView モニタリングを統合する必要がある場合は、WebView モニタリング を参照してください。
- Session Replay を統合する必要がある場合は、Android Session Replay を参照してください。