RUM 設定¶
RUM 初期化設定¶
let rumConfig: FTRUMConfig = {
androidAppId: Config.ANDROID_APP_ID,
iOSAppId: Config.IOS_APP_ID,
enableAutoTrackUserAction: true,
enableAutoTrackError: true,
enableNativeUserAction: true,
enableNativeUserView: false,
enableNativeUserResource: true,
enableIOSWebSocketResource: true,
sessionSamplingRate: 100,
errorMonitorType: ErrorMonitorType.all,
deviceMonitorType: DeviceMetricsMonitorType.all,
detectFrequency: DetectFrequency.rare,
enableLongTask: true,
longTaskThresholdMs: 200,
};
await FTReactNativeRUM.setConfig(rumConfig);
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| androidAppId | string | はい | app_id。RUM コンソールで申請します |
| iOSAppId | string | はい | app_id。RUM コンソールで申請します |
| sessionSamplingRate | number | いいえ | RUM セッションのサンプリング率(%)。範囲は [0,100]、小数をサポートし、デフォルトは 100 です。0 は収集なし、100 は全収集を表します。sampleRate より優先されます。SDK 0.4.3 以降でサポート。 |
| sessionOnErrorSamplingRate | number | いいえ | 通常のセッション サンプリングで選択されなかった場合のエラー セッション サンプリング率(%)。範囲は [0,100]、小数をサポートし、デフォルトは 0 です。sessionOnErrorSampleRate より優先されます。SDK 0.4.3 以降でサポート。 |
| visitorIdConfig | FTVisitorIdConfig | いいえ | SDK 0.4.3 以降でサポート。匿名訪問者識別子の設定で、デフォルトでは無効です。詳細は訪問者識別子 Visitor IDを参照してください |
| sampleRate | number | いいえ | SDK 0.4.3 以降で非推奨、互換性のため保持。sessionSamplingRate への変更を推奨します。値の範囲は [0,1] で、0 は収集なし、1 は全収集、デフォルト値は 1 です。スコープは同一 session_id 配下のすべての View、Action、LongTask、Error データです |
| sessionOnErrorSampleRate | number | いいえ | SDK 0.4.3 以降で非推奨、互換性のため保持。sessionOnErrorSamplingRate への変更を推奨します。セッションが通常のセッション サンプリングで選択されていない場合でも、セッション中にエラーが発生すると、エラー発生前 1 分間のデータを収集できます。値の範囲は [0,1] で、0 は収集なし、1 は全収集、デフォルト値は 0 です。スコープは同一 session_id 配下のすべての View、Action、LongTask、Error データです。SDK 0.3.14 以降でサポート |
| enableAutoTrackUserAction | boolean | いいえ | React Native コンポーネントのクリック イベントを自動収集するかどうか。有効にすると、accessibilityLabel と組み合わせて actionName を設定できます。SDK 0.4.3 以降では、Babel プラグインによる Action 名の自動生成を利用できます |
| enableAutoTrackError | boolean | いいえ | React Native Error を自動収集するかどうか。デフォルトは false です |
| enableNativeUserAction | boolean | いいえ | Native Action を追跡するかどうか。ネイティブ Button のクリック イベント、アプリ起動イベントが対象です。デフォルトは false です |
| enableNativeUserView | boolean | いいえ | Native View の自動追跡を行うかどうか。純粋な React Native アプリでは無効にすることを推奨します。デフォルトは false です |
| enableNativeUserResource | boolean | いいえ | ネイティブ HTTP(S) Resource の自動追跡を有効にするかどうか。Android の WebSocket ハンドシェイクもこの項目で制御されます。デフォルトは false です。iOS の WebSocket ハンドシェイクは、別途 enableIOSWebSocketResource を有効にする必要があります |
| enableIOSWebSocketResource | boolean | いいえ | SDK 0.4.3 以降でサポート。iOS React Native の WebSocket ハンドシェイク Resource を収集します。デフォルトは false で、enableNativeUserResource とは独立しています。詳細は WebSocket ハンドシェイクの収集を参照してください |
| errorMonitorType | enum ErrorMonitorType | いいえ | 補助モニタリング情報を設定し、RUM Error データに追加のモニタリング データを付加します。デフォルトでは無効です |
| deviceMonitorType | enum DeviceMetricsMonitorType | いいえ | View のライフサイクルにモニタリング データを追加します。デフォルトでは無効です |
| detectFrequency | enum DetectFrequency | いいえ | ビュー パフォーマンス モニタリングのサンプリング周期。デフォルトは DetectFrequency.normal です |
| enableResourceHostIP | boolean | いいえ | リクエスト先ドメインの IP を収集するかどうか。スコープ:enableNativeUserResource = true のデフォルト収集にのみ影響します。iOS:>= iOS 13 でサポート。Android:同一の OkhttpClient には IP キャッシュ機構があります |
| globalContext | object | いいえ | カスタム タグを追加し、ユーザー モニタリングのデータソースを区別するために使用します。追跡機能を使用する場合、パラメータ key は track_id、value は任意の数値です。追加ルールの注意事項はこちらを参照してください |
| enableTrackNativeCrash | boolean | いいえ | Android Java Crash と OC/C/C++ のクラッシュ モニタリングを有効にするかどうか。デフォルトは false です |
| enableTrackNativeAppANR | boolean | いいえ | Native ANR モニタリングを有効にするかどうか。デフォルトは false です |
| enableTrackNativeFreeze | boolean | いいえ | Native Freeze を収集するかどうか。デフォルトは false です |
| nativeFreezeDurationMs | number | いいえ | Native Freeze を収集する際のフリーズしきい値を設定します。値の範囲は [100,)、単位はミリ秒です。iOS のデフォルトは 250ms、Android のデフォルトは 1000ms です |
| enableLongTask | boolean | いいえ | React Native JS LongTask モニタリングを有効にするかどうか。デフォルトは false です。この設定は JS スレッドのスタッタリングのみを収集し、Native Freeze モニタリングとは独立しています。SDK 0.4.3 以降でサポート |
| longTaskThresholdMs | number | いいえ | React Native JS LongTask モニタリングのしきい値を設定します。値の範囲は [100, 5000]、単位はミリ秒、デフォルトは 100ms です。enableLongTask = true の場合にのみ有効です。100 未満の値は 100、5000 を超える値は 5000 として扱われます。SDK 0.4.3 以降でサポート |
| rumDiscardStrategy | string | いいえ | 破棄ポリシー:FTRUMCacheDiscard.discard は新規データを破棄(デフォルト)、FTRUMCacheDiscard.discardOldest は古いデータを破棄 |
| rumCacheLimitCount | number | いいえ | ローカル キャッシュの最大 RUM エントリ数制限 [10_000,)。デフォルトは 100_000 |
| enableTraceWebView | boolean | いいえ | WebView データの収集を有効にするかどうか。デフォルトは true です。SDK 0.3.16 以降でサポート |
| allowWebViewHost | Array |
いいえ | データ追跡を許可する WebView ホスト アドレスを設定します。null はすべてのホストを許可し、[] はすべてのホストを禁止します。SDK 0.3.16 以降でサポート。SDK 0.4.3 以降では FTMobileConfig.allowWebViewHost の使用を推奨します。このフィールドは互換性のために保持されており、基本設定が未設定の場合にのみ有効です。詳細は WebView ホスト設定を参照してください |
| iosCrashMonitoringType | enum IOSCrashMonitoringType | いいえ | SDK のクラッシュ モニタリングのタイプ範囲を設定します。デフォルトは IOSCrashMonitoringType.highCompatibility です。SDK 0.3.16 以降でサポート |
React Native JS LongTask の説明
有効にすると、SDK は React Native JS スレッドの隣接フレーム間隔を監視し、完全なフレーム間隔が longTaskThresholdMs を厳密に超えた場合に LongTask を送信します。現在のバージョンでは JS コール スタックを収集しません。
サンプリング設定¶
SDK 0.4.3 以降では小数のパーセント サンプリングをサポートします。
新しいフィールドの使用を推奨します。sessionSamplingRate: 12.5 はセッションの 12.5% を収集することを表し、sessionSamplingRate: 1 は 1%、100 は全収集を表します。
同じ項目に新旧のフィールドを同時に設定した場合、明示的に 0 を設定した場合も含め、新しいフィールドが優先されます。旧フィールドは [0,1] の意味を維持します。旧値をそのまま新フィールドにコピーしないでください。エラー セッション サンプリングは、通常のセッション サンプリングで選択されなかったセッションを対象とし、エラー発生時にエラー発生前 1 分間のデータを収集できます。
旧フィールドは SDK 0.4.3 以降で非推奨となり、互換性のために保持されています。アップグレード後は、実際に必要なパーセントに応じて新フィールドを設定することを推奨します。たとえば、全収集の設定は次のように移行します:
const rumConfig: FTRUMConfig = {
androidAppId: 'YOUR_ANDROID_APP_ID',
iOSAppId: 'YOUR_IOS_APP_ID',
- sampleRate: 1,
+ sessionSamplingRate: 100,
};
Log、Trace、Session Replay およびリモート設定の上書きルールも、対応するパーセント フィールドをサポートします。
RUM ユーザー データの追跡¶
FTRUMConfig では、enableAutoTrackUserAction、enableAutoTrackError、enableNativeUserAction、enableNativeUserView、enableNativeUserResource などの設定により自動収集を実現できます。手動で収集する場合は、以下の API も使用できます。
View¶
SDK の初期化時に RUM 設定 で enableNativeUserView を設定すると、Native View の自動収集を有効にできます。React Native View は、React Native が画面ナビゲーションを作成するための幅広いライブラリを提供しているため、デフォルトでは手動収集のみをサポートします。React Native View の自動収集が必要な場合は、後述の「React Native View の自動収集」を参照してください。
使用方法¶
/**
* view の読み込み時間。単位はナノ秒。
*/
onCreateView(viewName: string, loadTime: number): Promise<void>;
/**
* view の開始。
*/
startView(viewName: string, property?: object): Promise<void>;
/**
* view の終了。
*/
stopView(property?: object): Promise<void>;
使用例¶
import { FTReactNativeRUM } from '@cloudcare/react-native-mobile';
FTReactNativeRUM.onCreateView('viewName', duration);
FTReactNativeRUM.startView('viewName', { 'custom.foo': 'something' });
FTReactNativeRUM.stopView({ 'custom.foo': 'something' });
現在の View の読み込み時間を更新¶
SDK 0.4.3 以降でサポート。
startView() の後、stopView() の前に呼び出します:
duration は業務上の読み込み開始・終了境界から計算された時間で、単位はナノ秒です。非負の安全な整数である必要があります。経過時間の計算には単調クロックの使用を推奨します。ミリ秒の値は 1_000_000 を乗じて整数にしてください。この呼び出しは現在の View の読み込み時間を置き換えます。0 を渡すとクリアされます。このメソッドは現在アクティブな View のみを更新し、他の View の指定はサポートしません。
React Native View の自動収集¶
SDK 0.4.3 以降ではオプションのナビゲーション プラグインを提供します。
実際に使用するナビゲーション ライブラリに応じてプラグインを 1 つ選択し、メイン SDK と同じバージョンにしてください。プラグインには JavaScript と型宣言のみが含まれ、ネイティブのリンク設定は追加されません。先に SDK と RUM の初期化を完了してください。純粋な React Native 画面では enableNativeUserView: false を設定することを推奨します。
以前に example のナビゲーション収集ファイルをコピーした場合は、同じ名前のクラスをプラグインからインポートするように変更し、旧収集ロジックを削除して重複送信を避けてください。同時に使用する自動ナビゲーション収集方式は 1 つのみにしてください。プラグインはバックグラウンド移行時にネイティブと連携して View を終了し、フォアグラウンド復帰時に現在のページを再開します。以前の読み込み時間は再利用しません。
react-native-navigation¶
旧サンプル ファイルから移行する場合は、収集クラスのインポート パスを置き換えます:
- import { FTRumReactNativeNavigationTracking } from './FTRumReactNativeNavigationTracking';
+ import { FTRumReactNativeNavigationTracking } from '@cloudcare/mobile-react-native-navigation';
ナビゲーションのルート ページを表示する前に収集を有効にします:
import { FTRumReactNativeNavigationTracking } from '@cloudcare/mobile-react-native-navigation';
// SDK と RUM の初期化完了後、Navigation.setRoot() の前に呼び出します。
FTRumReactNativeNavigationTracking.startTracking();
ナビゲーション統合をアンインストールする前、または SDK を閉じる前に FTRumReactNativeNavigationTracking.stopTracking() を呼び出します。
プラグインはページの表示イベントと非表示イベントを収集します。読み込み時間は componentWillAppear から componentDidAppear までの間隔で、単位はナノ秒です。ページ上のすべての非同期コンテンツの読み込み完了を表すものではありません。ナビゲーション ライブラリが will-appear コールバックを提供しない場合、開始点がない場合、または時間が正でない場合は、View のみを収集し、読み込み時間を補完作成しません。
react-navigation¶
旧サンプル ファイルから移行する場合は、収集クラスのインポート パスを置き換えます。ナビゲーション ライブラリのインポートは変更しません:
- import { FTRumReactNavigationTracking } from './FTRumReactNavigationTracking';
+ import { FTRumReactNavigationTracking } from '@cloudcare/mobile-react-navigation';
import { createNativeStackNavigator } from '@react-navigation/native-stack';
ルート モードは通常のルート、ネストされたナビゲーション、および Tab に適用されます。コンテナの準備完了時に現在のリーフ ルートを記録し、その後ルート変更を追跡します。このモードでは読み込み時間を収集しません。
import { NavigationContainer, createNavigationContainerRef } from '@react-navigation/native';
import { FTRumReactNavigationTracking } from '@cloudcare/mobile-react-navigation';
const navigationRef = createNavigationContainerRef();
<NavigationContainer
ref={navigationRef}
onReady={() => FTRumReactNavigationTracking.startTrackingViews(navigationRef)}
>
{/* プロジェクトのナビゲーション コンポーネント */}
</NavigationContainer>;
コンテナをアンインストールする前、または SDK を閉じる前に FTRumReactNavigationTracking.stopTrackingViews(navigationRef) を呼び出します。
トランジション モードは @react-navigation/native-stack に適用され、ルート モードとはどちらか一方を選択します。ページ トランジションを担当する Stack に設定します:
import { FTRumReactNavigationTracking } from '@cloudcare/mobile-react-navigation';
<Stack.Navigator screenListeners={FTRumReactNavigationTracking.StackListener}>
{/* プロジェクトの Stack.Screen */}
</Stack.Navigator>;
上記の Stack は、プロジェクトで createNativeStackNavigator() により作成されたインスタンスを使用します。Stack をアンインストールする前、または SDK を閉じる前に FTRumReactNavigationTracking.stopTrackingViews() を呼び出します。再マウント時には StackListener を再取得し、クリーンアップ済みのリスナー オブジェクトを引き続き使用しないでください。
読み込み時間は、観測された focus から対応するオープン トランジションの transitionEnd までの単調時間間隔で、単位はナノ秒です。ネットワークやすべてのコンテンツの読み込み完了を表すものではありません。新しいページ インスタンスの初回表示時のみ収集します。既存ページへの戻り、Tab の切り替え、フォアグラウンド復帰では時間を重複して計測しません。開始点がない場合、または時間が正でない場合は読み込みデータを付加しません。ネストされたナビゲーションの各階層で重複して登録しないでください。
Expo Router¶
Expo Router を使用している場合は、app/_layout.js ファイルに次のメソッドを追加してデータを収集します。
import { useEffect } from 'react';
import { useSegments, usePathname, Slot } from 'expo-router';
import { FTReactNativeRUM } from '@cloudcare/react-native-mobile';
export default function Layout() {
const pathname = usePathname();
const segments = useSegments();
const viewKey = segments.join('/');
useEffect(() => {
FTReactNativeRUM.startView(viewKey);
}, [viewKey, pathname]);
return <Slot />;
}
Action¶
startAction と addAction の使用上の違い
startActionは内部で Action の所要時間を自動計算します。計算期間中は、近接して発生したResource、LongTask、Errorデータとの関連付けを可能な限り行い、100 ms の高頻度トリガー保護が設けられています。ユーザー操作タイプのデータに使用することを推奨します。- 頻繁に呼び出す必要がある場合は
addActionを使用してください。addActionで送信された Action はstartActionと競合せず、現在のResource、LongTask、Errorデータとも関連付けられません。
使用方法¶
/**
* RUM Action を開始します。
*/
startAction(actionName: string, actionType: string, property?: object): Promise<void>;
/**
* Action イベントを追加します。
*/
addAction(actionName: string, actionType: string, property?: object): Promise<void>;
使用例¶
import { FTReactNativeRUM } from '@cloudcare/react-native-mobile';
FTReactNativeRUM.startAction('actionName', 'actionType', { 'custom.foo': 'something' });
FTReactNativeRUM.addAction('actionName', 'actionType', { 'custom.foo': 'something' });
Error¶
使用方法¶
/**
* 例外のキャプチャとログ収集。
*/
addError(stack: string, message: string, property?: object): Promise<void>;
/**
* エラー タイプを指定した例外のキャプチャとログ収集。
*/
addErrorWithType(type: string, stack: string, message: string, property?: object): Promise<void>;
使用例¶
import { FTReactNativeRUM } from '@cloudcare/react-native-mobile';
FTReactNativeRUM.addError('error stack', 'error message', { 'custom.foo': 'something' });
FTReactNativeRUM.addErrorWithType('custom_error', 'error stack', 'error message', {
'custom.foo': 'something',
});
Resource¶
WebSocket ハンドシェイクの自動収集¶
SDK 0.4.3 以降では iOS React Native の WebSocket ハンドシェイク収集をサポートします。
RUM の初期化時に enableIOSWebSocketResource: true を設定し、初期化完了後に接続を作成します。このスイッチは enableNativeUserResource とは独立しています。Android ではネイティブ SDK を使用して自動収集するため、enableNativeUserResource を有効にし、Android の ft-plugin 設定を完了する必要があります。
収集範囲は接続確立時のハンドシェイクであり、接続確立後のメッセージ送受信は含みません。また、接続の存続時間全体を Resource の所要時間として扱いません。iOS の所要時間は、WebSocket コンストラクター呼び出しの収集境界から初回ハンドシェイクの成功または失敗の終了状態までを計算し、収集の開始・終了時刻をネイティブに渡すことで、後続のブリッジ処理遅延が結果に影響するのを防ぎます。この経路では DNS、TCP、TLS、最初のバイトなどの段階別所要時間は提供されません。実際の HTTP レスポンス情報がない場合、ステータス コードやレスポンス ヘッダーを偽造しません。Metro、Inspector、HMR、およびデバッガーの WebSocket リクエストはフィルターされます。
iOS WebSocket に Trace リクエスト ヘッダーを自動注入する必要がある場合は、FTTraceConfig.enableNativeAutoTrace も有効にする必要があります。Trace のみを有効にし、enableIOSWebSocketResource を有効にしていない場合、この経路による自動注入は行われません。
手動収集の使用方法¶
/**
* リソース リクエストを開始します。
*/
startResource(key: string, property?: object): Promise<void>;
/**
* リソース リクエストを終了します。
*/
stopResource(key: string, property?: object): Promise<void>;
/**
* リソース データのメトリクスを送信します。
*/
addResource(key: string, resource: FTRUMResource, metrics?: FTRUMResourceMetrics): Promise<void>;
使用例¶
import { FTReactNativeRUM } from '@cloudcare/react-native-mobile';
async function getHttp(url: string) {
const key = Utils.getUUID();
FTReactNativeRUM.startResource(key);
const fetchOptions = {
method: 'GET',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
},
};
let res: Response;
try {
res = await fetch(url, fetchOptions);
} finally {
const resource: FTRUMResource = {
url: url,
httpMethod: fetchOptions.method,
requestHeader: fetchOptions.headers,
};
if (res) {
resource.responseHeader = res.headers;
resource.resourceStatus = res.status;
resource.responseBody = await res.text();
}
FTReactNativeRUM.stopResource(key);
FTReactNativeRUM.addResource(key, resource);
}
}
Action のカスタム ルールの詳細については、データ収集のカスタム ルールを参照してください。