Android セッションリプレイ¶
前提条件¶
- FTSdk RUM 設定をセットアップおよび初期化し、View のモニタリング収集を有効にしていることを確認してください。
- Android Session Replay には
ft-sdk:1.7.0以降が必要です。 ft-session-replayとft-session-replay-materialは同じバージョン番号を使用する必要があります。ft-sdk1.7.2 以降ではft-session-replayへの強い依存はなくなりました。Session Replay を有効にする場合にのみ、ft-session-replayおよび関連する拡張依存関係を追加する必要があります。-
ドキュメント最上部の badge に表示される正式リリースの安定版を優先して使用することを推奨します。
alpha、betaなどのプレリリース版は使用しないことを推奨します。 -
先行して先進的な機能を利用したい場合、最新機能に関心がある場合、または未正式リリースの変更を追跡したい場合は、GitHub で Android SDK リポジトリおよび関連する更新ログをフォローできます:GuanceCloud/datakit-android
Android セッションヒートマップ(実験的機能)
Android セッションヒートマップでは、ft-sdk >= 1.7.4 と ft-session-replay >= 0.1.7 を同時に使用し、RUM のユーザー行動収集と Session Replay を有効にする必要があります。
ft-sdk >= 1.7.0 は引き続き通常の Android Session Replay の最低バージョン要件です。上記のバージョン組み合わせは Android セッションヒートマップにのみ適用されます。
設定¶
//SDK の依存関係を追加
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
//Session Replay 機能を有効にする必要がある
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay:[session_replay_version]'
//Session Replay をサポートするには material コンポーネントをサポートする必要がある
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-material:[session_replay_version]'
//Session Replay をサポートするには compose コンポーネントをサポートする必要がある
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'
Flutter RUM コンテキスト互換¶
ft-session-replay 0.1.5 以降は、Flutter Session Replay のアップロード時に使用される RUM コンテキストフィールドと互換性があります。Android ネイティブプロジェクト内に Flutter ページまたは Flutter SDK の収集経路が同時に存在する場合、ft-session-replay:0.1.5 以降にアップグレードすると、追加設定なしで Flutter Replay データを対応する Replay Segment に正しくマッピングできます。
混合シナリオでは、引き続き先に RUM を初期化してから Session Replay を初期化し、
app_id、session_id、view_idなどのコンテキストが確立されていることを確認することを推奨します。
コード呼び出し¶
FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
.setTouchPrivacy(TouchPrivacy.SHOW)
.setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
.setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
.addExtensionSupport(new MaterialExtensionSupport()), context);
| メソッド名 | 型 | 必須 | 説明 |
|---|---|---|---|
| setSessionReplaySamplingRate | float | いいえ | サンプリング割合(%)。範囲は [0,100]、デフォルトは 100、小数をサポートします。明示的な新フィールドは旧フィールドより優先されます。ft-session-replay >= 0.1.9 でサポートされます。 |
| setSampleRate | Float | いいえ | ft-session-replay 0.1.9 以降で非推奨。0~1 の単位での互換性を維持。収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 はすべて収集することを示します。デフォルト値は 1 です。 |
| setSessionReplayOnErrorSamplingRate | float | いいえ | サンプリング割合(%)。範囲は [0,100]、デフォルトは 0、小数をサポートします。明示的な新フィールドは旧フィールドより優先されます。ft-session-replay >= 0.1.9 でサポートされます。 |
| setSessionReplayOnErrorSampleRate | Float | いいえ | ft-session-replay 0.1.9 以降で非推奨。0~1 の単位での互換性を維持。エラー収集率を設定します。セッションが setSampleRate でサンプリングされていない場合、セッション中にエラーが発生すると、エラー発生前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 はすべて収集することを示します。デフォルト値は 0 です。ft-session-replay 0.1.2-alpha01 以降でサポートされます。 |
| setPrivacy | SessionReplayPrivacy | いいえ | SessionReplayPrivacy.ALLOW はプライバシーデータをマスクしません。SessionReplayPrivacy.MASK は文字、CheckBox、RadioButton、Switch を含むすべてのデータをマスクします。SessionReplayPrivacy.USER_INPUT(推奨)は入力欄の文字、CheckBox、RadioButton、Switch を含むユーザー入力の一部データをマスクします。デフォルトは SessionReplayPrivacy.MASK です。まもなく非推奨。互換性のため使用可能ですが、マスク設定には setTouchPrivacy、setTextAndInputPrivacy の使用を優先することを推奨します。 |
| setTextAndInputPrivacy | TextAndInputPrivacy | いいえ | TextAndInputPrivacy.MASK_SENSITIVE_INPUTS はパスワードなどの情報のみをマスクします。TextAndInputPrivacy.MASK_ALL_INPUTS は入力欄の文字、CheckBox、RadioButton、Switch を含むユーザー入力の一部データをマスクします。TextAndInputPrivacy.MASK_ALL は文字、CheckBox、RadioButton、Switch を含むすべてのデータをマスクします。デフォルトは TextAndInputPrivacy.MASK_ALL です。設定後は setPrivacy の設定を上書きします。ft-session-replay 0.1.1-alpha01 以降でサポートされます。 |
| setImagePrivacy | ImagePrivacy | いいえ | ImagePrivacy.MASK_ALL はすべての画像をマスクします。ImagePrivacy.MASK_LARGE_ONLY は大きな画像コンテンツ(100x100 dp より大きいコンテンツ画像)のみをマスクします。ImagePrivacy.MASK_NONE は画像をマスクしません。デフォルトは ImagePrivacy.MASK_ALL です。設定後は setPrivacy の設定を上書きします。ft-sdk >= 1.7.0-alpha40、ft-session-replay >= 0.1.3-alpha14 |
| setTouchPrivacy | TouchPrivacy | いいえ | TouchPrivacy.SHOW はタッチデータをマスクしません。TouchPrivacy.HIDE はタッチデータをマスクします。設定後は setPrivacy の設定を上書きします。ft-session-replay 0.1.1-alpha01 以降でサポートされます。 |
| addExtensionSupport | ExtensionSupport | いいえ | 追加のカスタムサポートを追加します。ft-session-replay-material を使用する場合、MaterialExtensionSupport を使用して Material コンポーネントの追加収集サポートを提供できます。 |
プライバシーオーバーライド¶
ft-session-replay 0.1.1-alpha01 以降でサポートされます。
SDK は FTSessionReplayConfig によるグローバルなマスクレベル設定に加えて、ビューレベルでこれらの設定を上書きできます。
ビューレベルのプライバシーオーバーライド:
- 画像マスクレベルの上書きをサポート
- テキストと入力のマスクレベルおよびタッチマスクレベルの上書きをサポート
- 特定のビューを完全に非表示に設定することをサポート
注意:
- オーバーライド設定を正しく認識するため、ビューのライフサイクル内でできるだけ早く適用してください。これにより、設定されたオーバーライドを適用する前に Session Replay がビューを処理する状況を防げます。
- プライバシーオーバーライドはビューとその子ビューに影響します。つまり、オーバーライドが適用されてもすぐには有効にならない可能性があるビュー(たとえば、テキスト入力に画像オーバーライドを適用する場合)でも、オーバーライドはすべての子ビューに適用されます。
- プライバシーオーバーライドの優先順位:子ビュー > 親ビュー > グローバル設定
画像オーバーライド¶
ft-sdk>= 1.7.0-alpha40、ft-session-replay>= 0.1.3-alpha14
画像プライバシーを上書きするには、ビューインスタンスで PrivacyOverrideExtensions.setSessionReplayImagePrivacy(View,ImagePrivacy) を使用し、ImagePrivacy 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除する場合は、このプロパティを直接 null に設定します。
テキストと入力のオーバーライド¶
テキストと入力のプライバシーを上書きするには、ビューインスタンスで PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(View,TextAndInputPrivacy) を使用し、TextAndInputPrivacy 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除する場合は、このプロパティを直接 null に設定します。
タッチオーバーライド¶
タッチプライバシーを上書きするには、ビューインスタンスで PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(View,TouchPrivacy) を使用し、TouchPrivacy 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除する場合は、このプロパティを直接 null に設定します。
非表示要素オーバーライド¶
完全に非表示にする必要がある機密要素には、PrivacyOverrideExtensions.setSessionReplayHidden(View,Boolean) を使用して設定します。
要素を非表示に設定すると、リプレイでは "Hidden" とマークされたプレースホルダーに置き換えられ、その子ビューは記録されません。
注意:ビューを非表示にマークしても、その要素上のタッチ操作の記録は停止されません。タッチ操作を非表示にするには、要素を非表示にマークするだけでなく、タッチオーバーライドも使用してください。
Webview Session Replay¶
ft-session-replay 0.1.3-alpha11、ft-sdk 1.7.0-alpha36 以降でサポートされます。
まず本ページのセッションリプレイ初期化と WebView ページの初期化 を完了してから、ページで記録を有効にします:
Tencent Webivew X5 サポート¶
Jetpack Compose サポート¶
ft-session-replay-composeとft-session-replayは同じバージョン番号を使用します。
Android Session Replay は Jetpack Compose 画面の収集とリプレイをサポートしています。Compose ページを使用する場合は、Compose 拡張依存関係を追加で導入し、FTSessionReplayConfig に ComposeExtensionSupport を追加する必要があります。
依存関係の追加¶
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'
初期化設定¶
FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
.setTouchPrivacy(TouchPrivacy.SHOW)
.setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
.setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
.addExtensionSupport(new ComposeExtensionSupport())
.addExtensionSupport(new MaterialExtensionSupport()), context);
FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
.setTouchPrivacy(TouchPrivacy.SHOW)
.setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
.setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
.addExtensionSupport(ComposeExtensionSupport())
.addExtensionSupport(MaterialExtensionSupport()), context)
Compose プライバシーオーバーライド¶
Compose ページでは、Modifier を介して Session Replay のプライバシー設定を上書きできます:
sessionReplayHide(Boolean):指定した Compose ノードを非表示にしますsessionReplayImagePrivacy(ImagePrivacy):画像プライバシーレベルを上書きしますsessionReplayTextAndInputPrivacy(TextAndInputPrivacy):テキストと入力のプライバシーレベルを上書きしますsessionReplayTouchPrivacy(TouchPrivacy):タッチプライバシーレベルを上書きします
現在の制限事項¶
- Compose のリプレイはセマンティックノードとコンポーネントのマッピングに依存するため、ピクセル単位の再現は保証されません。
- 現在、一般的なテキスト、入力欄、画像、ボタン、スイッチ、スライダー、ラジオボタン、チェックボックス、Tab、およびコンテナ系コンポーネントのリプレイをサポートしています。
Brush背景は現時点ではサポートされていません。たとえば線形グラデーションや放射状グラデーションなどの背景は元のグラデーション効果どおりに再現されません。重要なデモ領域では単色背景を優先して使用することを推奨します。