iOS セッションリプレイ¶
前提条件¶
SDK 1.6.8 以降では iOS 15 以降が必要です。旧バージョンからアップグレードする場合は 1.6.8 へのアップグレード要件 を参照してください。
* View のモニタリング収集を有効にしたうえで、GuanceSDKRUM 設定のセットアップと初期化 が完了していることを確認してください。
* iOS Session Replay のバージョンサポート:SDK.Version >= 1.6.0。
* 旧バージョンから SDK 1.6.6 以降にアップグレードする場合、Session Replay の製品名は GuanceSessionReplay に変更されます。移行ガイド を参照してください。
* ドキュメント最上部の badge に表示される正式リリースの安定版を優先して使用することを推奨します。alpha、beta などのプレリリース版は使用しないでください。
- 先行して最新機能を統合したい場合や、正式リリースされていない変更を追跡したい場合は、GitHub の iOS SDK リポジトリおよび関連する更新履歴をフォローしてください:GuanceCloud/datakit-ios
設定¶
使用するパッケージマネージャーに応じて、GuanceSDK ライブラリ内の GuanceSessionReplay 機能コンポーネントをプロジェクトにリンクします:
CocoaPods¶
Swift Package Manager¶
dependencies: [
.package(url: "https://github.com/GuanceCloud/datakit-ios.git",
from: "last_version")
],
targets: [
.target(
name: "YourTarget",
dependencies: [
.product(name: "GuanceSDK", package: "GuanceSDK"),
.product(name: "GuanceSessionReplay", package: "GuanceSDK"), // 追加
]),
]
Carthage/Framework¶
SDK 1.6.2 以降でサポート
Carthage または手動で Framework を統合する場合、基本 SDK に加えて、GuanceSessionReplay セッションリプレイコンポーネントもメインプロジェクトの Target の Frameworks に追加する必要があります。
GuanceSessionReplay はセッションリプレイ機能コンポーネントであり、GuanceSDK の基本機能に依存するため、単独では使用できません。
Objective-C のエントリポイント¶
Objective-C の import パスは統合方法によって異なります:
| 統合方法 | 推奨エントリポイント |
|---|---|
| CocoaPods | #import <GuanceSDK/GuanceSessionReplay.h> |
| Swift Package Manager | @import GuanceSessionReplay; |
| Carthage / Framework | #import <GuanceSessionReplay/GuanceSessionReplay.h> |
| 以下の Objective-C の例では、統一して Swift Package Manager の記法を使用しています。CocoaPods または Carthage / Framework で統合する場合は、上表に従ってエントリ行を置き換えてください。 |
コード呼び出し¶
@import GuanceSessionReplay;
FTSessionReplayConfig *srConfig = [[FTSessionReplayConfig alloc]init];
srConfig.touchPrivacy = FTTouchPrivacyLevelShow;
srConfig.textAndInputPrivacy = FTTextAndInputPrivacyLevelMaskSensitiveInputs;
srConfig.imagePrivacy = FTImagePrivacyLevelMaskNonBundledOnly;
// SwiftUI ページを収集する場合、SDK 1.6.5 以降で有効化できます
srConfig.enableSwiftUI = YES;
// Session Replay のヒートマップ連携を有効にする場合、SDK 1.6.6 以降で有効化できます
srConfig.enableHeatmap = YES;
srConfig.sessionReplaySamplingRate = 100; // SDK 1.6.8 以降でサポート
[[FTRumSessionReplay sharedInstance] startWithSessionReplayConfig:srConfig];
let srConfig = FTSessionReplayConfig.init()
srConfig.touchPrivacy = .show
srConfig.textAndInputPrivacy = .maskSensitiveInputs
srConfig.imagePrivacy = .maskNonBundledOnly
// SwiftUI ページを収集する場合、SDK 1.6.5 以降で有効化できます
srConfig.enableSwiftUI = true
// Session Replay のヒートマップ連携を有効にする場合、SDK 1.6.6 以降で有効化できます
srConfig.enableHeatmap = true
srConfig.sessionReplaySamplingRate = 100 // SDK 1.6.8 以降でサポート
FTRumSessionReplay.shared().start(with: srConfig)
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
| sessionReplaySamplingRate | float | いいえ | Session Replay のパーセンテージサンプリングレート。範囲は [0,100] で、小数をサポートします(0.1 は 0.1%、1 は 1% を表します)。デフォルトは 100(全サンプリング)です。RUM セッションのサンプリングに基づいて Replay のサンプリングを行います。旧リモートフィールドでは [0,1] の比率を使用します。リモートサンプリング設定 を参照してください。SDK 1.6.8 以降でサポート。 |
| sampleRate | int | いいえ | SDK 1.6.8 以降で非推奨、互換性のため保持。整数のパーセンテージサンプリングレート。範囲は [0,100]、デフォルトは 100 です。sessionReplaySamplingRate への変更を推奨します。 |
| sessionReplayOnErrorSamplingRate | float | いいえ | Replay のエラー時追加サンプリングのパーセンテージ。範囲は [0,100]、小数をサポートし、デフォルトは 0 です。通常の Replay サンプリングに該当しなかったセッションに使用します。SDK 1.6.8 以降でサポート。 |
| sessionReplayOnErrorSampleRate | int | いいえ | SDK 1.6.8 以降で非推奨、互換性のため保持。整数のパーセンテージによるエラー時追加サンプリング設定。範囲は [0,100]、デフォルトは 0 です。sessionReplayOnErrorSamplingRate への変更を推奨します。 |
| privacy | FTSRPrivacy | いいえ | Session Replay 内のコンテンツマスキングのプライバシーレベルを設定します。デフォルトは FTSRPrivacyMask です。マスキング処理:テキストを * または # に置き換えます。 FTSRPrivacyAllow: 機密入力コントロールを除くテキストと入力内容を記録し、ユーザーのタッチを表示し、すべての画像を記録します。FTSRPrivacyMaskUserInput: 入力要素をマスキングし、ユーザーのタッチを非表示にします。SF Symbols および [UIImage imageNamed:] / UIImage(named:) で読み込まれ、App に同梱された画像のみを記録します。FTSRPrivacyMask: すべてのテキスト、入力、タッチ、画像をマスキングします。まもなく非推奨。互換性のため使用可能ですが、 touchPrivacy、textAndInputPrivacy、imagePrivacy を使用した細かいマスキングプライバシーレベルの設定を優先してください |
| touchPrivacy | FTTouchPrivacyLevel | いいえ | Session Replay におけるタッチマスキングで使用可能なプライバシーレベル。デフォルトは FTTouchPrivacyLevelHide です。FTTouchPrivacyLevelShow: すべてのユーザータッチを表示しますFTTouchPrivacyLevelHide: すべてのユーザータッチをマスキングします設定後は privacy の設定を上書きしますSDK 1.6.1 以降でサポート |
| textAndInputPrivacy | FTTextAndInputPrivacyLevel | いいえ | Session Replay におけるテキストと入力のマスキングで使用可能なプライバシーレベル。デフォルトは FTTextAndInputPrivacyLevelMaskAll ですFTTextAndInputPrivacyLevelMaskSensitiveInputs: 機密入力以外のすべてのテキストを表示します。例:パスワード入力FTTextAndInputPrivacyLevelMaskAllInputs: すべての入力フィールドをマスキングします。例:UITextField、UISwitch、UISlider などFTTextAndInputPrivacyLevelMaskAll: すべてのテキストと入力をマスキングします設定後は privacy の設定を上書きしますSDK 1.6.1 以降でサポート |
| imagePrivacy | FTImagePrivacyLevel | いいえ | Session Replay における画像マスキングで使用可能なプライバシーレベル。デフォルトは FTImagePrivacyLevelMaskAll です。FTImagePrivacyLevelMaskNonBundledOnly: SF Symbols および [UIImage imageNamed:] / UIImage(named:) で読み込まれ、App に同梱された画像のみを記録します。ネットワークからダウンロードした画像や実行時に生成された画像はマスキングされます。FTImagePrivacyLevelMaskAll: すべての画像をマスキングします。FTImagePrivacyLevelMaskNone: ネットワークからダウンロードした画像や実行時に生成された画像を含むすべての画像を記録します。画像に機密コンテンツが含まれていないことを確認したうえで使用してください。設定後は privacy の設定を上書きしますSDK 1.6.2 以降でサポート |
| enableSwiftUI | BOOL | いいえ | SwiftUI ページのセッションリプレイ収集を有効にします。デフォルト値は NO です。SDK 1.6.5 以降でサポート |
| enableHeatmap | BOOL | いいえ | Session Replay のヒートマップ連携機能を有効にします。デフォルト値は NO で、実験的機能です。SDK 1.6.6 以降でサポート |
| enableLinkRUMKeys | NSArray | いいえ | 有効にすると、設定した keys に基づいて RUM Context の対応するフィールドをセッションリプレイデータに関連付けます。セッションリプレイデータの振り分けに使用できます SDK 1.6.2 以降でサポート |
注意:
enableHeatmapは自動収集された UIKit Action の関連付けにのみ使用されます。一部の UIKit Action は Heatmap をサポートしない場合があります。SwiftUI Action は現在自動収集をサポートしていないため、enableHeatmapでヒートマップを関連付けることはできません。
プライバシーオーバーライド¶
SDK 1.6.1 以降でサポート
SDK は FTSessionReplayConfig によるグローバルなマスキングレベルの設定に加えて、ビューレベルでこれらの設定をオーバーライドできます。
ビューレベルのプライバシーオーバーライド:
- テキストと入力のマスキングレベル、タッチのマスキングレベル、画像のマスキングレベルのオーバーライドをサポートします(SDK 1.6.2 以降でサポート)
- 特定のビューを完全に非表示にする設定をサポートします
注意:
- オーバーライドを正しく認識するために、ビューのライフサイクル内でできるだけ早く適用してください。これにより、設定したオーバーライドが適用される前にセッションリプレイがビューを処理することを防げます。
- プライバシーオーバーライドはビューとそのサブビューに影響します。つまり、すぐには効果を発揮しない可能性があるビューにオーバーライドを適用した場合(例:テキスト入力に画像オーバーライドを適用)でも、オーバーライドはすべてのサブビューに適用されます。
- プライバシーオーバーライドの優先順位:サブビュー > 親ビュー > グローバル設定
テキストと入力のオーバーライド¶
テキストと入力のプライバシーをオーバーライドするには、ビューインスタンスで sessionReplayPrivacyOverrides.textAndInputPrivacy を使用し、FTTextAndInputPrivacyLevelOverride 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除するには、このプロパティを FTTextAndInputPrivacyLevelOverrideNone に設定します。
タッチのオーバーライド¶
タッチのプライバシーをオーバーライドするには、ビューインスタンスで sessionReplayPrivacyOverrides.touchPrivacy を使用し、FTTouchPrivacyLevelOverride 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除するには、このプロパティを FTTouchPrivacyLevelOverrideNone に設定します。
画像のオーバーライド¶
SDK 1.6.2 以降でサポート
画像のプライバシーをオーバーライドするには、ビューインスタンスで sessionReplayPrivacyOverrides.imagePrivacy を使用し、FTImagePrivacyLevelOverride 列挙型のいずれかの値に設定します。既存のオーバーライドルールを削除するには、このプロパティを FTImagePrivacyLevelOverrideNone に設定します。
使用可能な画像オーバーライドレベル:
FTImagePrivacyLevelOverrideMaskNonBundledOnly: SF Symbols および[UIImage imageNamed:]/UIImage(named:)で読み込まれ、App に同梱された画像のみを記録します。ネットワークからダウンロードした画像や実行時に生成された画像はマスキングされます。FTImagePrivacyLevelOverrideMaskAll: すべての画像をマスキングします。FTImagePrivacyLevelOverrideMaskNone: ネットワークからダウンロードした画像や実行時に生成された画像を含むすべての画像を記録します。画像に機密コンテンツが含まれていないことを確認したうえで使用してください。
非表示要素のオーバーライド¶
完全に非表示にする必要がある機密要素には、sessionReplayPrivacyOverrides.hide を使用して設定します。
要素を非表示に設定すると、リプレイ内では "Hidden" のプレースホルダーに置き換えられ、そのサブビューは記録されません。
注意:ビューを非表示にマークしても、その要素上のタッチインタラクションの記録は停止されません。タッチインタラクションを非表示にするには、要素を非表示にマークするだけでなく、タッチのオーバーライド も使用してください。
Webview Session Replay¶
SDK 1.6.2 以降でサポート
まず本ページのセッションリプレイ初期化と WebView ページの初期化 を完了してから、ページで録画を有効にします: