クイックスタート¶
この記事では、Android RUM SDK の最短の導入経路を提供し、最小限の手順で検証可能なデータ送信を一度完了できるようにします。
アプリは Agent 自動導入と手動導入をサポートしています。以下の手順では、手動導入の最小設定について説明します。
前提条件¶
開始前に、次の準備を完了してください。
- リアルユーザーモニタリング(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を初期化します。 - デバッグログを有効にし、ページの表示またはネットワークリクエストを 1 回発生させて、データ送信が成功したことを確認します。
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を導入済みの場合はネットワークリクエストを 1 回送信します。 Logcatで[FT-SDK]を検索し、initRUMWithConfig completeやSync Successのようなログが出力されていることを確認します。- Guance コンソールに戻り、アプリに対応する RUM データが表示されていることを確認します。
次のステップ¶
- インストールと初期化の完全な説明については、アプリ導入を引き続きお読みください。
- すべての初期化パラメータの説明については、SDK 初期化をお読みください。
- RUM、Log、Trace の詳細設定については、RUM 設定、Log 設定、Trace 設定をお読みください。
- WebView モニタリングを導入する必要がある場合は、WebView モニタリングをお読みください。
- Session Replay を導入する必要がある場合は、Android Session Replayをお読みください。