React Native セッションリプレイ¶
前提条件¶
@cloudcare/react-native-mobileRUM 設定をセットアップして初期化し、View のモニタリング収集を有効にしていることを確認してください。- React Native セッションリプレイには
@cloudcare/react-native-mobile@0.4.0以上が必要です。 -
@cloudcare/react-native-mobile@0.4.1以降、セッションリプレイ機能は@cloudcare/react-native-session-replayによって提供されます。@cloudcare/react-native-mobileと@cloudcare/react-native-session-replayの両方をインストールし、2 つのライブラリのバージョン番号を一致させてください。 -
ドキュメント上部のバッジに表示される正式な安定版の使用を優先することを推奨します。alpha、beta などのプレリリース版は使用しないことを推奨します。
-
新しい機能をいち早く試したい場合、最新機能を追いたい場合、または正式リリース前の変更を追跡したい場合は、GitHub で React Native SDK リポジトリおよび関連する変更ログをフォローできます:GuanceCloud/datakit-react-native。
設定¶
npm install @cloudcare/react-native-mobile@last_version @cloudcare/react-native-session-replay@last_version
# または
yarn add @cloudcare/react-native-mobile@last_version @cloudcare/react-native-session-replay@last_version
コードでの呼び出し¶
以下の例は 0.4.1 以降に適用されます。セッションリプレイ関連の API は @cloudcare/react-native-session-replay からインポートします。
import {
FTReactNativeSessionReplay,
FTSessionReplayConfig,
TextAndInputPrivacyLevel,
} from '@cloudcare/react-native-session-replay';
let sessionReplayConfig: FTSessionReplayConfig = {
- sampleRate: 1,
+ sessionReplaySamplingRate: 100, // SDK 0.4.3 以降でサポート
textAndInputPrivacy: TextAndInputPrivacyLevel.MASK_SENSITIVE_INPUTS,
};
await FTReactNativeSessionReplay.sessionReplayConfig(sessionReplayConfig);
| プロパティ | 型 | 必須 | 意味 |
|---|---|---|---|
| sessionReplaySamplingRate | number | いいえ | セッションリプレイのサンプリング率(%)。範囲は [0,100] で小数をサポートし、デフォルトは 100 です。これは RUM サンプリングをベースにしたサンプリングレートであり、sampleRate より優先されます。SDK 0.4.3 以降でサポート。 |
| sessionReplayOnErrorSamplingRate | number | いいえ | 通常のリプレイサンプリングで選択されなかった場合のエラー時リプレイのサンプリング率(%)。範囲は [0,100] で小数をサポートし、デフォルトは 0 です。sessionReplayOnErrorSampleRate より優先されます。SDK 0.4.3 以降でサポート。 |
| sampleRate | number | いいえ | SDK 0.4.3 以降で非推奨、互換性のため保持。sessionReplaySamplingRate の使用を推奨します。値の範囲は [0,1] で、0 は収集しないこと、1 はすべて収集することを示し、デフォルト値は 1 です。このサンプリングレートは RUM サンプリングをベースにしています。 |
| sessionReplayOnErrorSampleRate | number | いいえ | SDK 0.4.3 以降で非推奨、互換性のため保持。sessionReplayOnErrorSamplingRate の使用を推奨します。値の範囲は [0,1] で、0 は収集しないこと、1 はすべて収集することを示し、デフォルト値は 0 です。 |
| privacy | SessionReplayPrivacy | いいえ | セッションリプレイ内のコンテンツマスクのプライバシーレベルを設定します。このパラメータは非推奨であり、旧バージョンとの互換性のために保持されています。touchPrivacy、textAndInputPrivacy、imagePrivacy を使用した詳細なプライバシー設定を優先することを推奨します。SessionReplayPrivacy.ALLOW:パスワード入力欄などの機密入力コントロールを除き、プライバシーデータをマスクしません。SessionReplayPrivacy.MASK_USER_INPUT:入力欄のテキスト、Switch など、ユーザー入力の一部のデータをマスクします。SessionReplayPrivacy.MASK:テキスト、Switch などのプライバシーデータをマスクします。まもなく非推奨、互換性のため利用可能。プライバシー設定には touchPrivacy、textAndInputPrivacy、imagePrivacy の使用を優先することを推奨 |
| touchPrivacy | TouchPrivacyLevel | いいえ | セッションリプレイ内のタッチ操作のプライバシーレベルを設定します。TouchPrivacyLevel.SHOW:タッチ操作を表示します。TouchPrivacyLevel.HIDE:タッチ操作を非表示にします。設定後、privacy の設定を上書きします。SDK 0.4.1 以降でサポート。 |
| textAndInputPrivacy | TextAndInputPrivacyLevel | いいえ | セッションリプレイ内のテキストおよび入力内容のプライバシーレベルを設定します。TextAndInputPrivacyLevel.MASK_SENSITIVE_INPUTS:機密入力のみをマスクします。TextAndInputPrivacyLevel.MASK_ALL_INPUTS:すべての入力内容をマスクします。TextAndInputPrivacyLevel.MASK_ALL:すべてのテキストと入力内容をマスクします。設定後、privacy の設定を上書きします。SDK 0.4.1 以降でサポート。 |
| imagePrivacy | ImagePrivacyLevel | いいえ | セッションリプレイ内の画像コンテンツのプライバシーレベルを設定します。ImagePrivacyLevel.MASK_NON_BUNDLED_ONLY:バンドルされていない画像をマスクします。ImagePrivacyLevel.MASK_ALL:すべての画像をマスクします。ImagePrivacyLevel.MASK_NONE:画像をマスクしません。設定後、privacy の設定を上書きします。SDK 0.4.1 以降でサポート。 |
ビューのプライバシーオーバーライド¶
SDK 0.4.1 以降でサポート。
FTSessionReplayView は、部分的なビューツリーにセッションリプレイのプライバシーオーバーライドを設定するために使用します。このコンポーネントの動作は React Native の View と同じで、個別にプライバシーポリシーを設定する必要があるコンポーネントのラップに使用できます。また、既存の View を直接置き換えることもできます。プライバシーオーバーライドはその子ビューに適用されます。複数階層のオーバーライドがある場合、子ビューは最も近い親のプライバシー設定を使用します。
import {
FTSessionReplayView,
ImagePrivacyLevel,
TextAndInputPrivacyLevel,
TouchPrivacyLevel,
} from '@cloudcare/react-native-session-replay';
| コンポーネント | 役割 | プロパティ |
|---|---|---|
FTSessionReplayView.Privacy |
子ビュー内のテキスト、入力、画像、タッチのプライバシーレベルをカスタマイズし、子ビュー全体を非表示にすることもできます。 | textAndInputPrivacy?: TextAndInputPrivacyLevelimagePrivacy?: ImagePrivacyLeveltouchPrivacy?: TouchPrivacyLevelhide?: boolean |
FTSessionReplayView.MaskAll |
子ビューに最も厳格なマスクポリシーを適用し、テキスト、入力、画像をマスクします。 | showTouch?: boolean、true に設定するとタッチ操作を表示します。 |
FTSessionReplayView.MaskNone |
子ビューにより緩いマスクポリシーを適用し、機密でないコンテンツと画像は可能な限りそのまま表示されます。 | 追加プロパティはありません。 |
FTSessionReplayView.Hide |
セッションリプレイで子ビューの内容を完全に非表示にします。 | 追加プロパティはありません。 |
ローカルコンポーネントをラップする¶
import { TextInput, View } from 'react-native';
import { FTSessionReplayView } from '@cloudcare/react-native-session-replay';
export function UserForm() {
return (
<View>
<FTSessionReplayView.MaskAll showTouch={true}>
<TextInput placeholder="First Name" value="Data" />
<TextInput placeholder="Last Name" value="Flux" />
</FTSessionReplayView.MaskAll>
</View>
);
}
既存の View を置き換える¶
FTSessionReplayView は React Native の View のプロパティを継承しており、元の View の style をそのまま渡すことができます。
import { StyleSheet, Text, TextInput } from 'react-native';
import { FTSessionReplayView } from '@cloudcare/react-native-session-replay';
export function ProfileCard() {
return (
<FTSessionReplayView.MaskNone style={styles.card}>
<Text>Public display name</Text>
<TextInput placeholder="Email" value="user@example.com" />
</FTSessionReplayView.MaskNone>
);
}
const styles = StyleSheet.create({
card: {
padding: 12,
borderRadius: 8,
backgroundColor: '#FFFFFF',
},
});
異なるプライバシーポリシーを組み合わせる¶
import {
FTSessionReplayView,
ImagePrivacyLevel,
TextAndInputPrivacyLevel,
TouchPrivacyLevel,
} from '@cloudcare/react-native-session-replay';
export function Checkout() {
return (
<FTSessionReplayView.Privacy
textAndInputPrivacy={TextAndInputPrivacyLevel.MASK_SENSITIVE_INPUTS}
imagePrivacy={ImagePrivacyLevel.MASK_NONE}
touchPrivacy={TouchPrivacyLevel.SHOW}>
{/* 通常のコンテンツ */}
<FTSessionReplayView.MaskAll showTouch={true}>
{/* 強力なマスクが必要なフォーム内容 */}
</FTSessionReplayView.MaskAll>
<FTSessionReplayView.Hide>
{/* リプレイに表示したくない内容 */}
</FTSessionReplayView.Hide>
</FTSessionReplayView.Privacy>
);
}
FTSessionReplayView.Hide を使用すると、子ビューはセッションリプレイで非表示になります。
WebView セッションリプレイ¶
SDK 0.4.1 以降でサポート、Android および iOS が対象です。
React Native WebView で Web ページを読み込む場合は、先に React Native RUM と本ページのセッションリプレイ設定を完了し、View のモニタリング収集を有効にしてください。Android ではさらに、Plugin の導入に従って ft-plugin の設定を完了し、アプリのメインモジュールでこのプラグインを適用したうえで、アプリを再ビルドしてインストールする必要があります。
WebView データモニタリングに従ってアプリ側の設定を完了し、FTRUMConfig.enableTraceWebView が true(デフォルト値)であること、および WebView host の設定が対象ページの収集を許可していることを確認してください。アプリ側の初期化が完了してから WebView を読み込み、WebView ページの初期化に従ってページを組み込んでください。
WebView で読み込まれるページでは、Web SDK RUM の初期化を完了した後に録画を開始します。
WebView では、Web 側 SDK のプライバシー設定を使用してページ内のコンテンツを管理することを推奨します。React Native 側のビューのプライバシーオーバーライドは、主にネイティブのビューツリーに作用します。