コンテンツにスキップ

RUM 設定

RUM 初期化設定

    //RUM を有効化
    FTRumConfig *rumConfig = [[FTRumConfig alloc]initWithAppid:appid];
    rumConfig.enableTraceUserView = YES;
    rumConfig.deviceMetricsMonitorType = FTDeviceMetricsMonitorAll;
    rumConfig.monitorFrequency = FTMonitorFrequencyRare;
    rumConfig.enableTraceUserAction = YES;
    rumConfig.enableTraceUserResource = YES;
    rumConfig.enableTrackAppFreeze = YES;
    rumConfig.enableTrackAppCrash = YES;
    rumConfig.enableTrackAppANR = YES;
    rumConfig.errorMonitorType = FTErrorMonitorAll;
    [[FTMobileAgent sharedInstance] startRumWithConfigOptions:rumConfig];
    let rumConfig = FTRumConfig(appid: appid)
    rumConfig.enableTraceUserView = true
    rumConfig.deviceMetricsMonitorType = .all
    rumConfig.monitorFrequency = .rare
    rumConfig.enableTraceUserAction = true
    rumConfig.enableTraceUserResource = true
    rumConfig.enableTrackAppFreeze = true
    rumConfig.enableTrackAppCrash = true
    rumConfig.enableTrackAppANR = true
    rumConfig.errorMonitorType = .all
    FTMobileAgent.sharedInstance().startRum(withConfigOptions: rumConfig)
属性 型 必須 意味
appid NSString は リアルユーザーモニタリング(RUM)アプリケーション ID の一意の識別子です。対応する RUM の appid を設定した場合にのみ、RUM の収集機能が有効になります。appid の取得方法
sessionSamplingRate float いいえ RUM セッションのサンプリングレートです。範囲は [0,100] で小数をサポートし、デフォルトは 100 です。0.1 は 0.1%、1 は 1% を表します。同一 Session 配下の RUM データに適用されます。SDK 1.6.8 以降でサポート。
sampleRate int いいえ SDK 1.6.8 以降は非推奨、互換性のため保持。整数パーセントのサンプリングレートで、範囲は [0,100]、デフォルトは 100 です。sessionSamplingRate への変更を推奨します。
sessionOnErrorSamplingRate float いいえ 通常のセッションサンプリングに該当しなかった場合のエラー補完サンプリング率です。範囲は [0,100] で小数をサポートし、デフォルトは 0 です。同一 Session の RUM データに適用されます。SDK 1.6.8 以降でサポート。
sessionOnErrorSampleRate int いいえ SDK 1.6.8 以降は非推奨、互換性のため保持。整数パーセントのエラー補完サンプリング設定で、範囲は [0,100]、デフォルトは 0 です。sessionOnErrorSamplingRate への変更を推奨します。
enableTrackAppCrash BOOL いいえ クラッシュログを収集するかどうかを設定します。デフォルトは NO
enableTrackAppANR BOOL いいえ ANR のフリーズ・無応答イベントを収集します。デフォルトは NO
enableTrackAppFreeze BOOL いいえ UI フリーズイベントを収集します。デフォルトは NO。-setEnableTrackAppFreeze:freezeDurationMs: メソッドでフリーズの収集を有効にし、フリーズしきい値を設定できます
freezeDurationMs long いいえ UI フリーズのしきい値を設定します。値の範囲は [100,)、単位はミリ秒、デフォルトは 250ms です。SDK 1.5.7 以降でサポート
enableTraceUserView BOOL いいえ ユーザーの View 操作を追跡するかどうかを設定します。デフォルトは NO
enableTraceUserViewLoadingTime BOOL いいえ SDK 1.6.9 以降でサポート。ページの loading_time を自動収集するかどうか。デフォルトは YES で、enableTraceUserView = YES のときに有効になります。NO に設定しても RUM View の追跡は維持されます。RUM の起動前に設定する必要があります。詳細は 収集制御 を参照してください
viewLoadingTimeClassNameExcludes NSArray<NSString *> いいえ SDK 1.6.9 以降でサポート。ページの読み込み時間を自動収集しないコントローラーの完全なランタイムクラス名の配列です。デフォルトは空の配列です。大文字と小文字を区別して完全一致で照合し、部分文字列、正規表現、継承関係による照合は行いません。カスタム View Name も使用しません。一致した場合も RUM View の追跡は維持されます。RUM の起動前に設定する必要があります。詳細は 収集制御 を参照してください
enableTraceUserAction BOOL いいえ ユーザーの Action 操作を追跡するかどうかを設定します。デフォルトは NO。view.accessibilityIdentifier で action_name をカスタマイズできます
launchPrewarmInterval NSInteger いいえ SDK 1.6.9 以降でサポート、iOS のみに適用されます。プリウォーム識別のしきい値をカスタマイズします。単位はミリ秒、デフォルトは 0(無効)で、必要に応じて 1500 の設定を推奨します。enableTraceUserAction を有効にする必要があります。システムのプリウォーム識別とトリミングは常に有効です。詳細は 起動プリウォーム識別 を参照してください
enableTraceUserResource BOOL いいえ ユーザーのネットワークリクエストを追跡するかどうかを設定します。デフォルトは NO で、native http にのみ適用されます。注意:[NSURLSession sharedSession] 経由で発行されたネットワークリクエストはパフォーマンスデータを収集できません。SDK 1.5.9 以降では Swift の URLSession async/await API 経由で発行されたネットワークリクエストの収集をサポートします
enableTraceURLConnectionResource BOOL いいえ SDK 1.6.8+:NSURLConnection の RUM Resource を自動収集します。デフォルトは NO。URLSession を制御する enableTraceUserResource とは独立しています。例は NSURLConnection の収集 を参照してください
visitorIDConfig FTVisitorIDConfig いいえ SDK 1.6.8+:匿名ビジター識別子(Visitor ID)の設定です。デフォルトは nil(無効)。詳細は ビジター識別子 Visitor ID を参照してください
nextViewActionPredicate id<FTRUMNextViewActionPredicate> いいえ SDK 1.6.8+:INV Action のマッチングルールです。デフォルトは click かつ間隔が 3 秒以内です。明示的に nil を指定すると INV を無効化します。App Extension はサポートしません。詳細は View 時間指標 を参照してください
networkSettledResourcePredicate id<FTRUMNetworkSettledResourcePredicate> いいえ SDK 1.6.8+:TNS 初期リクエストのマッチングルールです。デフォルトでは View 開始後 [0,100ms] にリクエストが開始されます。nil に設定するとデフォルトのルールに戻ります。詳細は View 時間指標 を参照してください
resourceUrlHandler FTResourceUrlHandler いいえ resource の収集ルールをカスタマイズします。デフォルトではフィルタリングしません。NO を返すと収集対象、YES を返すと収集不要を表します
errorMonitorType FTErrorMonitorType いいえ エラーイベント監視の補足タイプです。収集したクラッシュデータに監視情報を追加します。FTErrorMonitorBattery はバッテリー残量、FTErrorMonitorMemory はメモリ使用量、FTErrorMonitorCpu は CPU 使用率を表し、デフォルトでは設定されません
deviceMetricsMonitorType FTDeviceMetricsMonitorType いいえ ビューのパフォーマンス監視タイプです。デフォルトでは設定されません。収集した View データに対応する監視項目の情報を追加します。FTDeviceMetricsMonitorMemory は現在のアプリのメモリ使用状況、FTDeviceMetricsMonitorCpu は CPU の変動回数、FTDeviceMetricsMonitorFps は画面のフレームレートを監視します
monitorFrequency FTMonitorFrequency いいえ ビューのパフォーマンス監視のサンプリング周期です。FTMonitorFrequencyDefault は 500ms(デフォルト)、FTMonitorFrequencyFrequent は 100ms、FTMonitorFrequencyRare は 1000ms です
enableResourceHostIP BOOL いいえ リクエスト先ドメインアドレスの IP を収集するかどうか。>= iOS 13.0、>= tvOS 13.0 でサポートされます
globalContext NSDictionary いいえ カスタムタグを追加し、ユーザーモニタリングのデータソースを区別するために使用します。追跡機能を使用する場合、パラメータの key は track_id、value は任意の数値とします。追加ルールは こちら を参照してください
rumCacheLimitCount int いいえ RUM の最大キャッシュ量です。デフォルトは 100_000 で、SDK 1.5.8 以降でこのパラメータをサポートします
rumDiscardType FTRUMCacheDiscard いいえ RUM の破棄ルールを設定します。デフォルトは FTRUMCacheDiscard です。FTRUMCacheDiscard は RUM データ数が最大値を超えた場合に追加データを破棄し、FTRUMDiscardOldest は RUM データが最大値を超えた場合に古いデータを破棄します。SDK 1.5.8 以降でこのパラメータをサポートします
resourcePropertyProvider FTResourcePropertyProvider いいえ block コールバックで RUM Resource のカスタム属性を追加します。SDK 1.5.10 以降でこのパラメータをサポートします。優先度は URLSession カスタム収集 より低くなります
enableTraceWebView BOOL いいえ WebView データの収集を有効にするかどうかを設定します。デフォルトは YES。SDK 1.5.17 以降でサポート
allowWebViewHost NSArray いいえ SDK 1.6.8 以降は非推奨です。新しいコードでは FTSDKConfig.allowWebViewHost で WebView のホワイトリストを統一的に設定します。旧設定は互換性のためのフォールバックとして引き続き機能します。優先度は WebView データモニタリング を参照してください
sessionTaskErrorFilter FTSessionTaskErrorFilter いいえ URLSessionTask Error をインターセプトするかどうかを設定します。インターセプトする場合は YES、しない場合は NO を返します。インターセプトした場合、RUM-Error はそのエラーを収集しません。SDK 1.5.17 以降でサポート
issueDataProvider FTIssueDataProvider いいえ SDK が自動収集する Crash および ANR の RUM Error に、カスタムフィールドを同期して追加します。enableTrackAppCrash または enableTrackAppANR をそれぞれ有効にする必要があります。SDK 1.6.7 以降でサポート。使用方法は Error カスタムフィールド を参照してください
viewTrackingHandler FTViewTrackingHandler いいえ View の追跡ロジックをカスタマイズし、どの ViewController を RUM View として監視するか、および View Name のカスタマイズを決定するために使用します。有効条件:enableTraceUserView = YES。SDK 1.5.18 以降でサポート。使用例は こちら を参照してください
swiftUIViewTrackingHandler FTSwiftUIViewTrackingHandler いいえ 実験的。SwiftUI View の自動収集ロジックをカスタマイズし、自動抽出された SwiftUI View Name の絞り込みと RUM View Name のカスタマイズに使用します。有効条件:enableTraceUserView = YES かつこの設定が空でないこと。カスタムの絞り込みや命名が不要な場合は FTDefaultSwiftUIViewTrackingHandler を設定できます。この実験的 API は今後のバージョンで変更される可能性があります。SDK 1.6.4 以降でサポート。使用例は こちら を参照してください
actionTrackingHandler FTActionTrackingHandler いいえ Action の追跡ロジックをカスタマイズし、記録する RUM Action イベントの絞り込みと Action Name のカスタマイズに使用します。有効条件:enableTraceUserAction = YES。SDK 1.5.18 以降でサポート。使用例は こちら を参照してください
crashMonitoring FTCrashMonitorType いいえ SDK のクラッシュ監視のタイプ範囲を設定します。デフォルトは FTCrashMonitorTypeHighCompatibility(高互換モードのプリセットマクロ)です。有効条件:enableTrackAppCrash = YES。注意:FTCrashMonitorTypeSystem \| FTCrashMonitorTypeApplicationState を指定する必要があります。これらはレポートに重要な情報を提供します。SDK 1.5.19 以降でサポート
サンプリングレートパラメータの命名

SDK 1.6.8 以降では sessionSamplingRate の使用を推奨します。値は 0~100 のパーセントで、小数をサポートします。無効な値(範囲外、NaN、無限大)は元の設定を上書きしません。旧 sampleRate / samplerate は整数パーセントのみをサポートし、非推奨としてマークされており、将来のバージョンで削除される可能性があります。旧 getter で小数のサンプリングレートを読み取ると、整数部分が返されます。

リモートサンプリングフィールドの単位と優先度については リモート設定フィールド を参照してください。

RUM ユーザーデータの追跡

FTRUMConfig で enableTraceUserAction、enableTraceUserView、enableTraceUserResource、enableTrackAppFreeze、enableTrackAppCrash、enableTrackAppANR を設定することで、Action、View、Resource、LongTask、Error データの自動収集を追跡してデータを取得できます。カスタム収集を行う場合は、FTExternalDataManager を通じてデータを送信できます。

View

使用方法

/// ページを作成
///
/// `-startViewWithName` メソッドの前に呼び出します。このメソッドはページの読み込み時間を記録するために使用し、読み込み時間を取得できない場合は呼び出さなくてもかまいません。
/// - Parameters:
///  - viewName: ページ名
///  - loadTime: ページの読み込み時間(ナノ秒単位)
-(void)onCreateView:(NSString *)viewName loadTime:(NSNumber *)loadTime;

/// ページの表示を開始
/// - Parameters:
///  - viewName: ページ名
///  - property: イベントのカスタム属性(任意)
-(void)startViewWithName:(NSString *)viewName property:(nullable NSDictionary *)property;

/// 現在の RUM View の読み込み時間を更新します。
/// `-startView` と `-stopView` メソッドの間に呼び出した場合のみ有効になります。
/// - Parameter duration: 読み込み時間(ナノ秒単位)。
-(void)updateViewLoadingTime:(NSNumber *)duration;

/// ページの表示を終了
/// - Parameter property: イベントのカスタム属性(任意)
-(void)stopViewWithProperty:(nullable NSDictionary *)property;
/// ページを作成
///
/// `-startViewWithName` メソッドの前に呼び出します。このメソッドはページの読み込み時間を記録するために使用し、読み込み時間を取得できない場合は呼び出さなくてもかまいません。
/// - Parameters:
///  - viewName: ページ名
///  - loadTime: ページの読み込み時間(ns)
open func onCreateView(_ viewName: String, loadTime: NSNumber)

/// ページの表示を開始
/// - Parameters:
///  - viewName: ページ名
///  - property: イベントのカスタム属性(任意)
open func startView(withName viewName: String, property: [AnyHashable : Any]?)

/// 現在の RUM View の読み込み時間を更新します。
/// `-startView` と `-stopView` メソッドの間に呼び出した場合のみ有効になります。
/// - Parameter duration: 読み込み時間(ナノ秒単位)。
open func updateViewLoadingTime(_ duration: NSNumber)

/// ページの表示を終了
/// - Parameter property: イベントのカスタム属性(任意)
open func stopView(withProperty property: [AnyHashable : Any]?)

コード例

- (void)viewDidAppear:(BOOL)animated{
  [super viewDidAppear:animated];
  // シナリオ 1:
  [[FTExternalDataManager sharedManager] startViewWithName:@"TestVC"];

  // シナリオ 2:動的パラメータ
  [[FTExternalDataManager sharedManager] startViewWithName:@"TestVC" property:@{@"custom_key":@"custom_value"}];
}
-(void)viewDidDisappear:(BOOL)animated{
  [super viewDidDisappear:animated];
  // シナリオ 1:
  [[FTExternalDataManager sharedManager] stopView];

  // シナリオ 2:動的パラメータ
  [[FTExternalDataManager sharedManager] stopViewWithProperty:@{@"custom_key":@"custom_value"}];
}
override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    // シナリオ 1:
    FTExternalDataManager.shared().startView(withName: "TestVC")
    // シナリオ 2:動的パラメータ
    FTExternalDataManager.shared().startView(withName: "TestVC",property: ["custom_key":"custom_value"])
}
override func viewDidDisappear(_ animated: Bool) {
    super.viewDidDisappear(animated)
    // シナリオ 1:
    FTExternalDataManager.shared().stopView()
    // シナリオ 2:動的パラメータ
    FTExternalDataManager.shared().stopView(withProperty: ["custom_key":"custom_value"])
}

SwiftUI View の収集

SwiftUI View は自動収集と手動収集をサポートします:

  • 自動収集(実験的):SDK がページを自動的に識別し、FTRumConfig.swiftUIViewTrackingHandler で統一的に絞り込みと命名を行います。使用方法は SwiftUI View 自動収集(実験的) を参照してください。
  • 手動収集:具体的な SwiftUI View で .ftTrackRUMView(name:property:) を使用し、ページの開始と終了を明示的にマークして、View Name と属性をカスタマイズします。安定したページ名が必要な場合、View のライフサイクルを正確に制御したい場合、または自動抽出された名前が想定と異なる場合に適しています。
import SwiftUI
import GuanceSDK
struct HomeView: View {
    var body: some View {
        VStack {
            Text("Home")
        }
        .ftTrackRUMView(
            name: "Home",
            property: ["page_type": "home"]
        )
    }
}

Action

使用方法

/// RUM Action を開始します。
///
/// RUM はこの Action がトリガーする可能性のある Resource、Error、LongTask イベントをバインドします。0.1 s 以内に複数回追加することは避けてください。同じ View は同時に 1 つの Action のみに関連付けられ、前の Action が終了していない場合、新しく追加された Action は破棄されます。
/// `addAction:actionType:property` メソッドで追加した Action とは互いに影響しません。
///
/// - Parameters:
///   - actionName: イベント名
///   - actionType: イベントタイプ
///   - property: イベントのカスタム属性(任意)
- (void)startAction:(NSString *)actionName actionType:(NSString *)actionType property:(nullable NSDictionary *)property;

/// Action イベントを追加します。破棄ロジックはなく、Resource、Error、LongTask イベントをバインドしません
///
/// `startAction:actionType:property:` で開始した RUM Action とは互いに影響しません。
/// - Parameters:
///   - actionName: イベント名
///   - actionType: イベントタイプ
///   - property: イベントのカスタム属性(任意)
- (void)addAction:(NSString *)actionName actionType:(NSString *)actionType property:(nullable NSDictionary *)property;
/// RUM Action を開始します。
///
/// RUM はこの Action がトリガーする可能性のある Resource、Error、LongTask イベントをバインドします。0.1 s 以内に複数回追加することは避けてください。同じ View は同時に 1 つの Action のみに関連付けられ、前の Action が終了していない場合、新しく追加された Action は破棄されます。
/// `addAction:actionType:property` メソッドで追加した Action とは互いに影響しません。
///
/// - Parameters:
///   - actionName: イベント名
///   - actionType: イベントタイプ
///   - property: イベントのカスタム属性(任意)
open func startAction(_ actionName: String, actionType: String, property: [AnyHashable : Any]?)

/// Action イベントを追加します。破棄ロジックはなく、Resource、Error、LongTask イベントをバインドしません
///
/// `startAction:actionType:property:` で開始した RUM Action とは互いに影響しません。
/// - Parameters:
///   - actionName: イベント名
///   - actionType: イベントタイプ
///   - property: イベントのカスタム属性(任意)
open func addAction(_ actionName: String, actionType: String, property: [AnyHashable : Any]?)

コード例

// startAction
[[FTExternalDataManager sharedManager] startAction:@"action" actionType:@"click" property:@{@"action_property":@"testActionProperty1"}];
// addAction
[[FTExternalDataManager sharedManager] addAction:@"action" actionType:@"click" property:@{@"action_property":@"testActionProperty1"}];
// startAction
FTExternalDataManager.shared().startAction("custom_action", actionType: "click",property: nil)
// addAction
FTExternalDataManager.shared().addAction("custom_action", actionType: "click",property: nil)

SwiftUI Action の手動収集

SwiftUI Action は業務のインタラクション部分で手動で補完する必要があります。Button、NavigationLink、List の項目、カスタムジェスチャなどの SwiftUI コンポーネントでは、ユーザー操作が発生したことを確認した位置で能動的に RUM Action を記録してください。

SwiftUI Action は 2 つの手動収集方式をサポートします:

  • 既存のイベントクロージャ内で呼び出す:FTRUMSwiftUI.trackTapAction(name:property:) を使用します。追加のジェスチャは登録されないため、Button、NavigationLink、List、スクロールビュー、または既にカスタムジェスチャがあるシーンに適しています。
  • View Modifier を使用する:.ftTrackRUMTapAction(name:property:count:) を使用します。現在の View に simultaneousGesture を追加するため、通常の View のシンプルなクリック収集に適しています。

注意:同じクリックイベントをすでに FTExternalDataManager で手動収集している場合は、SwiftUI Action の手動収集を重ねて使用しないでください。重複した送信を防ぐためです。

import SwiftUI
import GuanceSDK
struct ProductView: View {
    var body: some View {
        Button("Buy") {
            FTRUMSwiftUI.trackTapAction(
                name: "buy_click",
                property: ["source": "product_detail"]
            )

            // 業務のクリックロジックを実行
            buy()
        }
    }

    private func buy() {
        // ...
    }
}
import SwiftUI
import GuanceSDK
struct ProductCard: View {
    var body: some View {
        Text("Buy")
            .ftTrackRUMTapAction(
                name: "buy_click",
                property: ["source": "product_card"]
            )
    }
}

FTRUMSwiftUI.trackTapAction(name:property:) はより推奨される手動収集方式で、特に既存のクリッククロージャを持つコンポーネントに適しています。.ftTrackRUMTapAction(name:property:count:) は簡便な記述方法ですが、追加のクリックジェスチャを登録するため、List、NavigationLink、スクロールコンテナ、複雑なジェスチャの組み合わせでは既存のインタラクションに影響する可能性があります。既存のクリッククロージャ内で FTRUMSwiftUI.trackTapAction(name:property:) を呼び出す方式に変更することを推奨します。

Error

使用方法

/// Error イベントを追加
/// - Parameters:
///   - type: error タイプ
///   - message: エラーメッセージ
///   - stack: スタック情報
///   - property: イベントのカスタム属性(任意)
- (void)addErrorWithType:(NSString *)type message:(NSString *)message stack:(NSString *)stack property:(nullable NSDictionary *)property;

/// Error イベントを追加
/// - Parameters:
///   - type: error タイプ
///   - state: プログラムの実行状態
///   - message: エラーメッセージ
///   - stack: スタック情報
///   - property: イベントのカスタム属性(任意)
- (void)addErrorWithType:(NSString *)type state:(FTAppState)state  message:(NSString *)message stack:(NSString *)stack property:(nullable NSDictionary *)property;
/// Error イベントを追加
/// - Parameters:
///   - type: error タイプ
///   - message: エラーメッセージ
///   - stack: スタック情報
///   - property: イベントのカスタム属性(任意)
open func addError(withType: String, message: String, stack: String, property: [AnyHashable : Any]?)

/// Error イベントを追加
/// - Parameters:
///   - type: error タイプ
///   - state: プログラムの実行状態
///   - message: エラーメッセージ
///   - stack: スタック情報
///   - property: イベントのカスタム属性(任意)
open func addError(withType type: String, state: FTAppState, message: String, stack: String, property: [AnyHashable : Any]?)

コード例

// シナリオ 1
[[FTExternalDataManager sharedManager] addErrorWithType:@"type" message:@"message" stack:@"stack"];
// シナリオ 2:動的パラメータ
[[FTExternalDataManager sharedManager] addErrorWithType:@"ios_crash" message:@"crash_message" stack:@"crash_stack" property:@{@"custom_key":@"custom_value"}];
// シナリオ 3:動的パラメータ
[[FTExternalDataManager sharedManager] addErrorWithType:@"ios_crash" state:FTAppStateUnknown message:@"crash_message" stack:@"crash_stack" property:@{@"custom_key":@"custom_value"}];
// シナリオ 1
FTExternalDataManager.shared().addError(withType: "custom_type", message: "custom_message", stack: "custom_stack")
// シナリオ 2:動的パラメータ
FTExternalDataManager.shared().addError(withType: "custom_type", message: "custom_message", stack: "custom_stack",property: ["custom_key":"custom_value"])
// シナリオ 3:動的パラメータ
FTExternalDataManager.shared().addError(withType: "custom_type", state: .unknown, message: "custom_message", stack: "custom_stack", property: ["custom_key":"custom_value"])

LongTask

使用方法

/// フリーズイベントを追加
/// - Parameters:
///   - stack: フリーズのスタック
///   - duration: フリーズの継続時間(ナノ秒)
///   - property: イベントのカスタム属性(任意)
- (void)addLongTaskWithStack:(NSString *)stack duration:(NSNumber *)duration property:(nullable NSDictionary *)property;
/// フリーズイベントを追加
/// - Parameters:
///   - stack: フリーズのスタック
///   - duration: フリーズの継続時間(ナノ秒)
///   - property: イベントのカスタム属性(任意)
func addLongTask(withStack: String, duration: NSNumber, property: [AnyHashable : Any]?)

コード例

// シナリオ 1
[[FTExternalDataManager sharedManager] addLongTaskWithStack:@"stack string" duration:@1000000000];
// シナリオ 2:動的パラメータ
[[FTExternalDataManager sharedManager] addLongTaskWithStack:@"stack string" duration:@1000000000 property:@{@"custom_key":@"custom_value"}];
// シナリオ 1
FTExternalDataManager.shared().addLongTask(withStack: "stack string", duration: 1000000000)
// シナリオ 2:動的パラメータ
FTExternalDataManager.shared().addLongTask(withStack: "stack string", duration: 1000000000 ,property: [["custom_key":"custom_value"]])

Resource

使用方法

/// HTTP リクエスト開始
/// - Parameters:
///   - key: リクエスト識別子
///   - property: イベントのカスタム属性(任意)
- (void)startResourceWithKey:(NSString *)key property:(nullable NSDictionary *)property;

/// HTTP リクエストデータを追加
///
/// - Parameters:
///   - key: リクエスト識別子
///   - metrics: リクエスト関連のパフォーマンス属性
///   - content: リクエスト関連のデータ
- (void)addResourceWithKey:(NSString *)key metrics:(nullable FTResourceMetricsModel *)metrics content:(FTResourceContentModel *)content;

/// HTTP リクエスト終了
/// - Parameters:
///   - key: リクエスト識別子
///   - property: イベントのカスタム属性(任意)
- (void)stopResourceWithKey:(NSString *)key property:(nullable NSDictionary *)property;
/// HTTP リクエスト開始
/// - Parameters:
///   - key: リクエスト識別子
///   - property: イベントのカスタム属性(任意)
open func startResource(withKey key: String, property: [AnyHashable : Any]?)

/// HTTP リクエスト終了
/// - Parameters:
///   - key: リクエスト識別子
///   - property: イベントのカスタム属性(任意)
open func stopResource(withKey key: String, property: [AnyHashable : Any]?)

/// HTTP リクエストデータを追加
///
/// - Parameters:
///   - key: リクエスト識別子
///   - metrics: リクエスト関連のパフォーマンス属性
///   - content: リクエスト関連のデータ
open func addResource(withKey key: String, metrics: FTResourceMetricsModel?, content: FTResourceContentModel)

コード例

//ステップ 1:リクエスト開始前
[[FTExternalDataManager sharedManager] startResourceWithKey:key];

//ステップ 2:リクエスト完了
[[FTExternalDataManager sharedManager] stopResourceWithKey:key];

//ステップ 3:Resource データを組み立てる
//FTResourceContentModel データ
FTResourceContentModel *content = [[FTResourceContentModel alloc]init];
content.httpMethod = request.HTTPMethod;
content.requestHeader = request.allHTTPHeaderFields;
content.responseHeader = httpResponse.allHeaderFields;
content.httpStatusCode = httpResponse.statusCode;
content.responseBody = responseBody;
//ios native
content.error = error;

//各段階の時間データを取得できる場合
//FTResourceMetricsModel
//ios native で NSURLSessionTaskMetrics データを取得した場合は、FTResourceMetricsModel の初期化メソッドをそのまま使用
FTResourceMetricsModel *metricsModel = [[FTResourceMetricsModel alloc]initWithTaskMetrics:metrics];

//その他のプラットフォームでは、すべての時間データはナノ秒単位
FTResourceMetricsModel *metricsModel = [[FTResourceMetricsModel alloc]init];

//ステップ 4:add resource 時間データがない場合は metrics に nil を渡す
[[FTExternalDataManager sharedManager] addResourceWithKey:key metrics:metricsModel content:content];
//ステップ 1:リクエスト開始前
FTExternalDataManager.shared().startResource(withKey: key)

//ステップ 2:リクエスト完了
FTExternalDataManager.shared().stopResource(withKey: resource.key)

//ステップ 3:① Resource データを組み立てる
let contentModel = FTResourceContentModel(request: task.currentRequest!, response: task.response as? HTTPURLResponse, data: resource.data, error: error)

//② 各段階の時間データを取得できる場合
//FTResourceMetricsModel
//ios native で NSURLSessionTaskMetrics データを取得した場合は、FTResourceMetricsModel の初期化メソッドをそのまま使用
var metricsModel:FTResourceMetricsModel?
if let metrics = resource.metrics {
   metricsModel = FTResourceMetricsModel(taskMetrics:metrics)
}
//その他のプラットフォームでは、すべての時間データはナノ秒単位
metricsModel = FTResourceMetricsModel()
...

//ステップ 4:add resource 時間データがない場合は metrics に nil を渡す
FTExternalDataManager.shared().addResource(withKey: resource.key, metrics: metricsModel, content: contentModel)

NSURLConnection Resource の自動収集

SDK 1.6.8+ でサポート

既存の NSURLConnection リクエストがあるプロジェクトでは、Resource の自動収集を独立して有効にできます。このスイッチは URLSession の enableTraceUserResource を置き換えたり、自動的に有効化したりするものではありません。

FTRumConfig *rumConfig = [[FTRumConfig alloc] initWithAppid:appid];
rumConfig.enableTraceURLConnectionResource = YES;
// URLSession を併用する場合は、必要に応じて別途 enableTraceUserResource を設定します。
[[FTSDKAgent sharedInstance] startRumWithConfigOptions:rumConfig];
let rumConfig = FTRumConfig(appid: appid)
rumConfig.enableTraceURLConnectionResource = true
FTSDKAgent.sharedInstance().startRum(withConfigOptions: rumConfig)

デフォルトでは無効です。リクエストのフィルタリング、カスタム Resource 属性、エラーフィルタリングには引き続き resourceUrlHandler、resourcePropertyProvider、sessionTaskErrorFilter を使用します。Trace リクエストヘッダが必要な場合は、別途 NSURLConnection Trace を有効にします。各パフォーマンスフィールドは収集側で実際に利用可能なデータに基づき、URLSessionTaskMetrics のすべての明細を備えることは保証されません。

フィードバック

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