コンテンツにスキップ

RUM 設定

サンプリングフィールドの移行(ft-sdk >= 1.7.6):setSessionSamplingRate は 0〜100 の浮動小数点パーセントを使用します。旧 setSamplingRate は 0〜1 の単位を維持し、移行時は数値を 100 倍してください。新フィールドは明示的に設定された場合にのみ優先され、不正な値は例外をスローし、以前の有効な値は変更されません。このバージョン未満では従来のメソッドを引き続き使用してください。非推奨は削除を意味せず、旧メソッドは元の単位と動作を維持します。

RUM 初期化設定

FTSdk.initRUMWithConfig(
        new FTRUMConfig()
            .setRumAppId(RUM_APP_ID)
            .setEnableTraceUserView(true)
            .setDeviceMetricsMonitorType(DeviceMetricsMonitorType.ALL.getValue())
            .setEnableTraceUserAction(true)
            .setEnableTraceUserResource(true)
            .setEnableTrackAppUIBlock(true)
            .setEnableTrackAppCrash(true)
            .setEnableTrackAppANR(true)
            .setExtraMonitorTypeWithError(ErrorMonitorType.ALL.getValue())
);
FTSdk.initRUMWithConfig(
    FTRUMConfig()
        .setRumAppId(RUM_APP_ID)
        .setEnableTraceUserView(true)
        .setDeviceMetricsMonitorType(DeviceMetricsMonitorType.ALL.getValue())
        .setEnableTraceUserAction(true)
        .setEnableTraceUserResource(true)
        .setEnableTrackAppUIBlock(true)
        .setEnableTrackAppCrash(true)
        .setEnableTrackAppANR(true)
        .setExtraMonitorTypeWithError(ErrorMonitorType.ALL.getValue())
)
メソッド名 型 必須 意味
setRumAppId String 必須 RUM AppId を設定します。RUM の appid を設定すると、RUM の収集機能が有効になります。appid の取得方法
setSessionSamplingRate Float 任意 サンプリング比率(パーセント)。範囲は [0,100]、デフォルトは 100 です。小数もサポートされ、例えば 0.1 は 0.1% を意味します。0 は収集しないことを、100 は全収集を意味します。新しいフィールドを明示的に設定した場合は、設定順序に関係なく旧フィールドより優先されます。ft-sdk >= 1.7.6 でサポートされています。
setSamplingRate Float 任意 ft-sdk 1.7.6 以降非推奨ですが、互換性のために維持されます。収集率を設定します。範囲は [0,1]、0 は収集しないことを、1 は全収集を意味し、デフォルト値は 1 です。スコープは同一の session_id 配下のすべての View、Action、LongTask、Error データです。
setSessionOnErrorSamplingRate float 任意 エラーセッションのサンプリング比率(パーセント)。範囲は [0,100]、デフォルトは 0 で、小数もサポートされます。通常セッションがサンプリングされず、エラーが発生した場合、この比率に従ってエラー発生前 1 分間のデータを補完収集します。明示的に設定された新フィールドは旧フィールドより優先されます。ft-sdk >= 1.7.6 でサポートされています。
setSessionErrorSampleRate Float 任意 ft-sdk 1.7.6 以降非推奨ですが、0〜1 の互換性を維持します。エラー収集率を設定します。セッションが setSamplingRate でサンプリングされていない場合、セッション中にエラーが発生すると、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]、0 は収集しないことを、1 は全収集を意味し、デフォルト値は 0 です。スコープは同一の session_id 配下のすべての View、Action、LongTask、Error データです。ft-sdk 1.6.11 以降でサポートされています。
setEnableTrackAppCrash Boolean 任意 App のクラッシュログを報告するかどうか。デフォルトは false で、有効にするとエラー分析でエラースタックデータが表示されます。クラッシュログ内の難読化された内容の変換については、シンボルファイルのアップロード を参照してください。ft-sdk 1.5.1 以降では、extraLogCatWithJavaCrash、extraLogCatWithNativeCrash で Java Crash と Native Crash で logcat を表示するかどうかを設定できます。
setIssueDataProvider FTIssueDataProvider 任意 自動収集された Java/Native Crash および watchdog/native ANR Error に、検証済みのカスタムフィールドを追加します。履歴復旧データも含まれます。デフォルトでは設定されません。ft-sdk 1.7.5 以降でサポートされています。詳細は Crash/ANR カスタムフィールド を参照してください。
setExtraMonitorTypeWithError Array 任意 補助モニタリング情報を設定し、追加のモニタリングデータを RUM クラッシュデータに追加します。ErrorMonitorType.BATTERY はバッテリー残量、ErrorMonitorType.MEMORY はメモリ使用量、ErrorMonitorType.CPU は CPU 使用率です。デフォルトでは設定されません。
setDeviceMetricsMonitorType Array 任意 View のモニタリング情報を設定し、View のライフサイクル中にモニタリングデータを追加します。DeviceMetricsMonitorType.BATTERY は現在のページの最大電流出力状況を監視し、DeviceMetricsMonitorType.MEMORY は現在のアプリのメモリ使用状況を監視し、DeviceMetricsMonitorType.CPU は CPU の変動回数を監視し、DeviceMetricsMonitorType.FPS は画面のフレームレートを監視します。モニタリング間隔は DetectFrequency.DEFAULT(500 ミリ秒)、DetectFrequency.FREQUENT(100 ミリ秒)、DetectFrequency.RARE(1 秒)から選択できます。デフォルトでは設定されません。
setEnableTrackAppANR Boolean 任意 ANR 収集を有効にするかどうか。デフォルトは false です。ft-sdk 1.7.5 以降、Android 11(API 30)以上では、プロセスの次回起動時に ApplicationExitInfo を通じて致命的な ANR を復元します。致命的でないリアルタイム ANR は収集しません。Android 10(API 29)以下では、引き続きリアルタイムの watchdog/native ANR 収集を使用します。extraLogCatWithANR は API 29 以下のリアルタイム収集パスでのみ使用されます。
setEnableTrackAppUIBlock Boolean, long 任意 UI のカクつき(ブロック)検出を有効にするかどうか。デフォルトは false です。ft-sdk 1.6.4 以降では、blockDurationMs で検出時間の範囲 [100,) を制御できます。単位はミリ秒で、デフォルトは 1 秒です。
setEnableTraceUserAction Boolean 任意 ユーザー操作を自動追跡するかどうか。現在はユーザーによる起動操作とクリック操作のみサポートしています。この設定は ft-plugin に依存し、デフォルトは false です。
setEnableTraceUserView Boolean 任意 ユーザーのページ操作を自動追跡するかどうか。この設定は ft-plugin に依存し、デフォルトは false です。
setEnableTraceUserViewInFragment Boolean 任意 Fragment タイプのページデータを自動追跡するかどうか。この設定は ft-plugin に依存し、デフォルトは false です。ft-sdk 1.6.11 以降でサポートされています。
setInitialResourceIdentifier FTInitialResourceIdentifier 任意 ネイティブ View の network_settled_time 計算に参加する Resource の判定ルールを設定します。デフォルトでは 100 ms の時間ウィンドウを使用します。null は受け付けません。ルールが false を返した場合、その指標への寄与が除外されるだけで、Resource イベントは破棄されません。詳細は View 所要時間指標のカスタムルール を参照してください。
setLastInteractionIdentifier FTLastInteractionIdentifier 任意 ネイティブ View の interaction_to_next_view_time における前ページのインタラクション判定ルールを設定します。デフォルトでは時間差が 0 より大きく 3000 ms 未満であることが必要です。null を渡すと自動 INV が無効になります。詳細は View 所要時間指標のカスタムルール を参照してください。
setEnableTraceUserResource Boolean 任意 ネットワークリクエストの Resource を収集するかどうか。デフォルトは false です。OkHttp、HttpURLConnection / HttpsURLConnection、OkHttp WebSocket ハンドシェイクに対応しています。各方式の導入要件は Resource 自動収集 を参照してください。
setEnableHttpURLConnectionResource Boolean 任意 HttpURLConnection / HttpsURLConnection の Resource を自動収集するかどうか。デフォルトは false です。setEnableTraceUserResource(true) も同時に有効にする必要があります。ft-sdk >= 1.7.6-alpha03 と ft-plugin >= 1.3.9-alpha01 が必要です。詳細は URLConnection 自動収集 を参照してください。
setEnableResourceHostIP Boolean 任意 リクエスト先ドメインの IP を収集するかどうか。スコープ:enableTraceUserResource が true の場合の OkHttp デフォルト収集にのみ影響し、URLConnection には適用されません。カスタムの Resource 収集では、FTResourceEventListener.FTFactory(true) を使用してこの機能を有効にする必要があります。また、個々の OkHttp には同じドメインに対する IP キャッシュメカニズムがあり、同じ OkHttpClient の場合、接続先サーバーの IP が変わらない限り、IP は 1 回だけ生成されます。
setResourceUrlHandler Callback 任意 フィルタリングする Resource の条件を設定します。デフォルトではフィルタリングしません。
setOkHttpEventListenerHandler Callback 任意 ASM でグローバルな OkHttp EventListener を設定します。デフォルトでは設定されません。
setOkHttpResourceContentHandler Callback 任意 ASM でグローバルな FTResourceInterceptor.ContentHandlerHelper を設定します。デフォルトでは設定されません。ft-sdk 1.6.7 以降でサポートされています。Resource のカスタマイズ
addGlobalContext Dictionary 任意 カスタムタグを追加します。RUM データソースの識別に使用します。トレーシング機能を使用する場合は、引数の key を track_id、value を任意の数値にします。追加ルールの注意事項はこちらを参照してください。
setVisitorIdConfig FTVisitorIdConfig 任意 匿名訪問者識別子 Visitor ID を設定します。デフォルトは null(無効)です。有効な設定を渡すと有効になります。OkHttp への Header 注入は RUM/Trace のサンプリングおよび Resource 収集のスイッチとは独立しています。ft-sdk >= 1.7.6-alpha04 でサポートされています。詳細は 訪問者識別子 Visitor ID を参照してください。
setRumCacheLimitCount int 任意 ローカルキャッシュの RUM 件数上限 [10_000,)。デフォルトは 100_000 です。ft-sdk 1.6.6 以降でサポートされています。
setEnableTraceWebView Boolean 任意 Android SDK による WebView データ収集を有効にするかどうか。デフォルトは true です。ft-sdk 1.6.12 以降でサポートされています。
setAllowWebViewHost Array 任意 データ追跡を許可する WebView の host アドレスを設定します。null は全収集を意味し、デフォルトは null です。ft-sdk 1.6.12 以降でサポートされています。このメソッドは非推奨で、ft-sdk 1.7.5 以降は FTSDKConfig.setAllowWebViewHost を使用して WebView の RUM と Log を一括設定してください。
setViewActivityTrackingHandler FTViewActivityTrackingHandler 任意 Activity ビューの追跡方法をカスタマイズします。Activity のライフサイクルイベントが発生すると、このハンドラーが呼び出され、その Activity の追跡方法が決定されます。デフォルトでは何も処理しません。ft-sdk 1.6.13 以降でサポートされています。
setViewFragmentTrackingHandler FTViewFragmentTrackingHandler 任意 Fragment ビューの追跡方法をカスタマイズします。Fragment のライフサイクルイベントが発生すると、このハンドラーが呼び出され、その Fragment の追跡方法が決定されます。デフォルトでは何も処理しません。ft-sdk 1.6.13 以降でサポートされています。
setActionTrackingHandler FTActionTrackingHandler 任意 ユーザー操作の追跡方法をカスタマイズします。ユーザーが操作を実行すると、このハンドラーが呼び出され、その操作の追跡方法が決定されます。デフォルトでは何も処理しません。ft-sdk 1.6.13 以降でサポートされています。

RUM 手動計装

FTRUMConfig で enableTraceUserAction、enableTraceUserView、enableTraceUserResource、setEnableTrackAppUIBlock、setEnableTrackAppCrash、setEnableTrackAppANR を設定することで、Action、View、Resource、LongTask、Error を自動収集できます。収集をカスタマイズする場合は、FTRUMGlobalManager を使用して手動で報告できます。

Action

使用方法

/**
 * Action を追加
 *
 * @param actionName action 名
 * @param actionType action タイプ
 * @param property   追加の属性パラメータ(オプション)
 */
public void startAction(String actionName, String actionType, HashMap<String, Object> property)

/**
 * Action を追加。この種のデータは Error、Resource、LongTask データと関連付けられません
 *
 * @param actionName action 名
 * @param actionType action タイプ
 * @param duration   継続時間(ナノ秒)(オプション)
 * @param property   拡張プロパティ(オプション)
 */
public void addAction(String actionName, String actionType, long duration, HashMap<String, Object> property)
/**
 * Action を追加
 *
 * @param actionName action 名
 * @param actionType action タイプ
 * @param property   追加の属性パラメータ(オプション)
 */
fun startAction(actionName: String, actionType: String, property: HashMap<String, Any>)

/**
 * Action を追加
 *
 * @param actionName action 名
 * @param actionType action タイプ
 * @param duration   継続時間(ナノ秒)(オプション)
 * @param property   拡張プロパティ(オプション)
 */
fun addAction(actionName: String, actionType: String, duration: Long, property: HashMap<String, Any>)

startAction は内部で所要時間を計算するアルゴリズムを備えており、計算中は近くで発生した Resource、LongTask、Error データとの関連付けを試みます。100 ms の頻繁なトリガーを防ぐ保護が設定されているため、ユーザー操作タイプのデータに適しています。頻繁に呼び出す必要がある場合は addAction を使用してください。このデータは startAction と競合せず、その時点の Resource、LongTask、Error データとも関連付けられません。

コード例

// シナリオ 1
FTRUMGlobalManager.get().startAction("login", "action_type");

// シナリオ 2: 動的パラメータ
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key", "ft_value");
FTRUMGlobalManager.get().startAction("login", "action_type", map);

// シナリオ 1
FTRUMGlobalManager.get().addAction("login", "action_type");

// シナリオ 2: 動的パラメータ
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key", "ft_value");
FTRUMGlobalManager.get().addAction("login", "action_type", map);
// シナリオ 1
FTRUMGlobalManager.get().startAction("login", "action_type")

// シナリオ 2: 動的パラメータ
val map = HashMap<String, Any>()
map["ft_key"] = "ft_value"
FTRUMGlobalManager.get().startAction("login", "action_type", map)

// シナリオ 1
FTRUMGlobalManager.get().addAction("login", "action_type")

// シナリオ 2: 動的パラメータ
val map = HashMap<String, Any>()
map["ft_key"] = "ft_value"
FTRUMGlobalManager.get().addAction("login", "action_type", map)

View

使用方法

/**
 * view 開始
 *
 * @param viewName 現在のページ名
 * @param property 追加の属性パラメータ(オプション)
 */
public void startView(String viewName, HashMap<String, Object> property)

/**
 * view 終了
 *
 * @param property 追加の属性パラメータ(オプション)
 */
public void stopView(HashMap<String, Object> property)

/**
 * 現在の view の loading_time メトリクスを更新します。単位はナノ秒
 *
 * @param duration duration
 */
public void updateLoadTime(long duration)
/**
 * view 開始
 *
 * @param viewName 現在のページ名
 * @param property 追加の属性パラメータ(オプション)
 */
fun startView(viewName: String, property: HashMap<String, Any>)

/**
 * view 終了
 *
 * @param property 追加の属性パラメータ(オプション)
 */
fun stopView(property: HashMap<String, Any>)

/**
 * 現在の view の loading_time メトリクスを更新します。単位はナノ秒
 *
 * @param duration duration
 */
fun updateLoadTime(duration: Long)

コード例

@Override
protected void onResume() {
    super.onResume();

    // シナリオ 1
    FTRUMGlobalManager.get().startView("Current Page Name");

    // シナリオ 2: 動的パラメータ
    HashMap<String, Object> map = new HashMap<>();
    map.put("ft_key", "ft_value");
    map.put("ft_key_will_change", "ft_value");
    FTRUMGlobalManager.get().startView("Current Page Name", map)
}

@Override
protected void onPause() {
    super.onPause();

    // シナリオ 1
    FTRUMGlobalManager.get().stopView();

    // シナリオ 2 : 動的パラメータ
    HashMap<String, Object> map = new HashMap<>();
    map.put("ft_key_will_change", "ft_value_change"); // ft_key_will_change の値は stopView 時に ft_value_change に更新されます
    FTRUMGlobalManager.get().stopView(map);

}
override fun onResume() {
    super.onResume()

    // シナリオ 1
    FTRUMGlobalManager.get().startView("Current Page Name")

    // シナリオ 2: 動的パラメータ
    val map = HashMap<String, Any>()
    map["ft_key"] = "ft_value"
    map["ft_key_will_change"] = "ft_value"
    FTRUMGlobalManager.get().startView("Current Page Name", map)
}

override fun onPause() {
    super.onPause()

    // シナリオ 1
    FTRUMGlobalManager.get().stopView()

    // シナリオ 2 : 動的パラメータ
    val map = HashMap<String, Any>()
    map["ft_key_will_change"] = "ft_value_change" // ft_key_will_change の値は stopView 時に ft_value_change に変更されます
    FTRUMGlobalManager.get().stopView(map)
}

Error

使用方法

/**
 * エラー情報を追加
 *
 * @param log       ログ
 * @param message   メッセージ
 * @param errorType エラータイプ、ErrorType
 * @param state     プログラムの実行状態
 * @param dateline  発生時刻、ナノ秒(オプション)
 * @param property  追加の属性(オプション)
 */
public void addError(String log, String message, long dateline, ErrorType errorType,
                     AppState state, HashMap<String, Object> property)

/**
 * エラー情報を追加
 *
 * @param log       ログ
 * @param message   メッセージ
 * @param errorType エラータイプ、String
 * @param state     プログラムの実行状態
 * @param dateline  発生時刻、ナノ秒(オプション)
 * @param property  追加の属性(オプション)
 */
public void addError(String log, String message, long dateline, String errorType,
                     AppState state, HashMap<String, Object> property)
/**
 * エラー情報を追加
 *
 * @param log       ログ
 * @param message   メッセージ
 * @param errorType エラータイプ、ErrorType
 * @param state     プログラムの実行状態
 * @param dateline  発生時刻、ナノ秒(オプション)
 * @param property  追加の属性(オプション)
 */
fun addError(log: String, message: String, dateline: Long, errorType: ErrorType, state: AppState, property: HashMap<String, Any>)

/**
 * エラー情報を追加
 *
 * @param log       ログ
 * @param message   メッセージ
 * @param errorType エラータイプ、String
 * @param state     プログラムの実行状態
 * @param dateline  発生時刻、ナノ秒(オプション)
 * @param property  追加の属性(オプション)
 */
fun addError(log: String, message: String, dateline: Long, errorType: String, state: AppState, property: HashMap<String, Any>)

コード例

// シナリオ 1:
FTRUMGlobalManager.get().addError("error log", "error msg", ErrorType.JAVA, AppState.RUN);

// シナリオ 2: 発生したエラーを遅延記録する場合。ここでの時間は通常、エラーが発生した時刻です
FTRUMGlobalManager.get().addError("error log", "error msg", 16789000000000000000L, ErrorType.JAVA, AppState.RUN);

// シナリオ 3: 動的パラメータ
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key", "ft_value");
FTRUMGlobalManager.get().addError("error log", "error msg", ErrorType.JAVA, AppState.RUN, map);
// シナリオ 1:
FTRUMGlobalManager.get().addError("error log", "error msg", ErrorType.JAVA, AppState.RUN)

// シナリオ 2: 発生したエラーを遅延記録する場合。ここでの時間は通常、エラーが発生した時刻です
FTRUMGlobalManager.get().addError("error log", "error msg", 16789000000000000000, ErrorType.JAVA, AppState.RUN)

// シナリオ 3: 動的パラメータ
val map = HashMap<String, Any>()
map["ft_key"] = "ft_value"
FTRUMGlobalManager.get().addError("error log", "error msg", ErrorType.JAVA, AppState.RUN, map)

LongTask

使用方法

/**
 * ロングタスクを追加
 *
 * @param log      ログ内容
 * @param duration 継続時間、ナノ秒
 * @param property 追加の属性パラメータ(オプション)
 */
public void addLongTask(String log, long duration, HashMap<String, Object> property)
/**
 * ロングタスクを追加
 *
 * @param log      ログ内容
 * @param duration 継続時間、ナノ秒
 * @param property 追加の属性パラメータ(オプション)
 */
fun addLongTask(log: String, duration: Long, property: HashMap<String, Any>)

コード例

// シナリオ 1
FTRUMGlobalManager.get().addLongTask("error log", 1000000L);

// シナリオ 2: 動的パラメータ
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key", "ft_value");
FTRUMGlobalManager.get().addLongTask("", 1000000L, map);
// シナリオ 1
FTRUMGlobalManager.get().addLongTask("error log", 1000000L)

// シナリオ 2: 動的パラメータ
val map = HashMap<String, Any>()
map["ft_key"] = "ft_value"
FTRUMGlobalManager.get().addLongTask("", 1000000L, map)

Resource

使用方法

/**
 * resource 開始
 *
 * @param resourceId リソース ID
 * @param property   追加の属性パラメータ(オプション)
 */
public void startResource(String resourceId, HashMap<String, Object> property)

/**
 * resource 終了
 *
 * @param resourceId リソース ID
 * @param property   追加の属性パラメータ(オプション)
 */
public void stopResource(final String resourceId, HashMap<String, Object> property)

/**
 * ネットワーク転送内容を設定
 *
 * @param resourceId resourceId
 * @param params params
 * @param netStatusBean netStatusBean
 */
public void addResource(String resourceId, ResourceParams params, NetStatusBean netStatusBean)
/**
 * resource 開始
 *
 * @param resourceId リソース ID(オプション)
 */
fun startResource(resourceId: String, property: HashMap<String, Any>)

/**
 * resource 終了
 *
 * @param resourceId リソース ID
 * @param property   追加の属性パラメータ(オプション)
 */
fun stopResource(resourceId: String, property: HashMap<String, Any>)

/**
 * ネットワーク転送内容を設定
 *
 * @param resourceId resourceId
 * @param params params
 * @param netStatusBean netStatusBean
 */
fun addResource(resourceId: String, params: ResourceParams, netStatusBean: NetStatusBean)

コード例

// シナリオ 1
// リクエスト開始
FTRUMGlobalManager.get().startResource("resourceId");

// ...

// リクエスト終了
FTRUMGlobalManager.get().stopResource("resourceId");

// 最後に、リクエスト終了後にリクエスト関連のデータメトリクスを送信します
ResourceParams params = new ResourceParams();
params.setUrl("https://guance.com");
params.setResponseContentType(response.header("Content-Type"));
params.setResponseConnection(response.header("Connection"));
params.setResponseContentEncoding(response.header("Content-Encoding"));
params.setResponseHeader(response.headers().toString());
params.setRequestHeader(request.headers().toString());
params.setResourceStatus(response.code());
params.setResourceMethod(request.method());

NetStatusBean bean = new NetStatusBean();
bean.setTcpStartTime(60000000);
// ...

FTRUMGlobalManager.get().addResource("resourceId", params, bean);

// シナリオ 2: 動的パラメータの使用
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key", "ft_value");
map.put("ft_key_will_change", "ft_value");

FTRUMGlobalManager.get().startResource("resourceId", map);

// ...
HashMap<String, Object> map = new HashMap<>();
map.put("ft_key_will_change", "ft_value_change"); // ft_key_will_change の値は stopResource 時に ft_value_change に変更されます
FTRUMGlobalManager.get().stopResource(uuid, map);
// シナリオ 1
// リクエスト開始
FTRUMGlobalManager.get().startResource("resourceId")

// リクエスト終了
FTRUMGlobalManager.get().stopResource("resourceId")

// 最後に、リクエスト終了後にリクエスト関連のデータメトリクスを送信します
val params = ResourceParams()
params.url = "https://guance.com"
params.responseContentType = response.header("Content-Type")
params.responseConnection = response.header("Connection")
params.responseContentEncoding = response.header("Content-Encoding")
params.responseHeader = response.headers.toString()
params.requestHeader = request.headers.toString()
params.resourceStatus = response.code
params.resourceMethod = request.method

val bean = NetStatusBean()
bean.tcpStartTime = 60000000
// ...
FTRUMGlobalManager.get().addResource("resourceId", params, bean)

// シナリオ 2: 動的パラメータの使用
val map = hashMapOf<String, Any>(
    "ft_key" to "ft_value",
    "ft_key_will_change" to "ft_value"
)
FTRUMGlobalManager.get().startResource("resourceId", map)

// ...
val map = hashMapOf<String, Any>(
    "ft_key_will_change" to "ft_value_change"
)
// ft_key_will_change の値は stopResource 時に ft_value_change に変更されます

FTRUMGlobalManager.get().stopResource(uuid, map)
メソッド名 必須 意味 説明
NetStatusBean.fetchStartTime 任意 リクエスト開始時間
NetStatusBean.tcpStartTime 任意 TCP 接続時間
NetStatusBean.tcpEndTime 任意 TCP 終了時間
NetStatusBean.dnsStartTime 任意 DNS 開始時間
NetStatusBean.dnsEndTime 任意 DNS 終了時間
NetStatusBean.responseStartTime 任意 レスポンス開始時間
NetStatusBean.responseEndTime 任意 レスポンス終了時間
NetStatusBean.sslStartTime 任意 SSL 開始時間
NetStatusBean.sslEndTime 任意 SSL 終了時間
NetStatusBean.property 任意 追加の属性
ResourceParams.url 必須 URL アドレス
ResourceParams.requestHeader 任意 リクエストヘッダーパラメータ
ResourceParams.responseHeader 任意 レスポンスヘッダーパラメータ
ResourceParams.responseConnection 任意 レスポンスの connection
ResourceParams.responseContentType 任意 レスポンスの ContentType
ResourceParams.responseContentEncoding 任意 レスポンスの ContentEncoding
ResourceParams.resourceMethod 任意 リクエストメソッド GET、POST など
ResourceParams.responseBody 任意 レスポンスボディの内容
ResourceParams.property 任意 追加の属性

Resource 自動収集

ネットワークリクエストの自動収集には ft-plugin の導入が必要で、RUM 初期化時に setEnableTraceUserResource(true) を有効にします。Resource URL のフィルタリングと RUM のサンプリングルールは、以下のすべての収集方法に適用されます。

OkHttp

setEnableTraceUserResource(true) を有効にすると、SDK はプラグインで計装された OkHttp の HTTP/HTTPS リクエストを自動収集します。リクエストコードの変更は不要です。OkHttpClient を作成する前に SDK の初期化を完了してください。

プラグインを使用しない場合は、OkHttp Resource / Trace の手動導入 に従って設定できます。

HttpURLConnection / HttpsURLConnection

ft-sdk >= 1.7.6-alpha03 と ft-plugin >= 1.3.9-alpha01 が必要です。接続を作成する前に、以下の 2 つのスイッチを両方有効にしてください:

FTSdk.initRUMWithConfig(new FTRUMConfig()
    .setRumAppId(RUM_APP_ID)
    .setEnableTraceUserResource(true)
    .setEnableHttpURLConnectionResource(true));
FTSdk.initRUMWithConfig(
    FTRUMConfig()
        .setRumAppId(RUM_APP_ID)
        .setEnableTraceUserResource(true)
        .setEnableHttpURLConnectionResource(true)
)
  • 収集範囲: プラグインで計装された URL.openConnection() および openConnection(Proxy) の HTTP/HTTPS リクエスト。プラグインオプション instrumentHttpURLConnection はデフォルトで有効です。リフレクション、システム内部、または計装対象から除外された呼び出しは収集されません。
  • 収集データ: URL、メソッド、リクエストヘッダー、レスポンスヘッダー、ステータスコード、実際に読み書きされたバイト数、総所要時間。本文、DNS/TCP/TLS のフェーズ別所要時間、対象 IP は収集されません。総所要時間にはアプリがレスポンスストリームを読み取る時間が含まれます。レスポンスを最後まで読み取っていない場合、バイト数は完全なレスポンスサイズより小さくなることがあります。
  • 使用上の注意: レスポンスストリームを正常に読み取り、閉じてから、リクエスト終了後に disconnect() を呼び出してください。SSE などの長時間接続リクエストはフィルタリングすることを推奨します。他の収集レイヤーと同時に使用する場合は、重複報告を避けてください。
  • 関連機能: Trace Header の注入と RUM トレースの関連付けは別途設定が必要です。URLConnection Trace を参照してください。Visitor ID の Header 注入はサポートされていません。

WebSocket ハンドシェイク Resource

ft-sdk >= 1.7.5 と ft-plugin >= 1.3.8 が必要です。setEnableTraceUserResource(true) を有効にすると、OkHttp の newWebSocket() によるハンドシェイクリクエストが自動収集されます。追加のスイッチは不要です。

ハンドシェイクのたびに 1 つの Resource が生成され、成功、拒否、失敗のステータスが記録されます。接続の存続時間は集計されず、メッセージ内容も収集されません。自動収集に対応したプラグインを使用しない場合は、FTWebSocket を使用して手動で導入できます。

フィードバック

このページは役に立ちましたか?