セッションリプレイ Standalone SDK
セッションリプレイの計測
セッションリプレイはデフォルトでは有効になっておらず、標準の Amplitude 計測以外の設定が必要です。
セッションリプレイ スタンドアロン SDK は、Amplitude Browser SDK とは独立してセッション録画をサイトに追加します。製品内分析にAmplitude以外のプロバイダーを使用している場合は、このオプションを選択してください。 サイトで既に Amplitude Browser SDK を使用している場合は、セッションリプレイ Browser SDK プラグインを使用してください。
セッションリプレイとパフォーマンス
Amplitudeは、以下の方法でウェブページのパフォーマンスへの影響を最小限に抑えるようにセッションリプレイを構築しました。
- Webhookを介して非同期処理を行うことにより(有効な場合)、効率的な圧縮と最適化されたバンドルサイズを実現します。
- バッチ処理と軽量圧縮を使用してネットワーク接続と帯域幅を削減します。
- DOM処理の最適化。
バンドルサイズ
セッションリプレイのスタンドアロンSDKは、アプリケーションのバンドルサイズを増加させます。
現在のバンドルサイズに関する情報は、npm パッケージページまたは BundlePhobia を確認してください。
ランタイムパフォーマンス
セッションリプレイは非同期に実行され、メインスレッドをブロックしないようにバックグラウンドでリプレイデータを処理します。パフォーマンス特性には次のものがあります:
- DOMキャプチャ: DOMスナップショットキャプチャによる処理時間の増加は、通常、ページインタラクションごとに5ミリ秒未満です。ページの複雑さに応じて、最初のページロードスナップショットキャプチャには10~50ミリ秒かかります。
- メモリ使用量: セッションリプレイはリプレイイベントをメモリまたは IndexedDB に保存します (
storeTypeを使用して設定できます)。 メモリ使用量はセッション時間とページの複雑さによって変化します。通常、各アクティブなセッションについては1〜10MBの範囲です。 - CPU への影響:デフォルト設定では、セッションリプレイは通常動作時に CPU 時間の 2% 未満を使用します。 Amplitude は、
performanceConfig.enabledがtrueに設定されている場合(デフォルト)、ブラウザのアイドル期間まで圧縮操作を延期します。 - ネットワーク帯域幅:Amplitude はアップロード前にリプレイデータを圧縮し、通常ペイロードサイズを 60 ~ 80% 削減します。 Amplitudeはネットワークリクエストをバッチ処理し、非同期に送信します。
パフォーマンスの最適化
セッションリプレイのパフォーマンスを最適化するには:
useWebWorkerを有効にすると、圧縮処理がメインスレッドから切り離され、メインスレッドへのCPUの影響が軽減されます。- 遅延圧縮が発生するタイミングを制御するように
performanceConfig.timeoutを構成します。 sampleRateを使用してキャプチャされるセッションの数を減らすことで、CPU とメモリの使用量を直接削減できます。- ページの再読み込み時に持続性を必要としない場合は、
storeTypeをmemoryに設定します。これによりIndexedDBのオーバーヘッドが削減されます。
パフォーマンス テストの詳細な結果については、「セッションリプレイ パフォーマンス テスト」に関するブログ記事を参照してください。
セッションリプレイは、ページのドキュメントオブジェクトモデル (DOM) に対する変更(シャドウ DOM 内の要素など)をキャプチャし、これらの変更を再生してビデオのような再生を構築します。セッションの開始時に、セッションリプレイはページの DOM の完全なスナップショットをキャプチャします。ユーザーがページとやり取りする際、セッションリプレイは DOM への各変更を diff としてキャプチャします。セッションのリプレイを視聴するとき、セッションリプレイは各 diff を順番に元の DOM に適用し、リプレイを構築します。セッションリプレイには最大長はありません。
SDKの初期化を遅延
ページが読み込まれるまでセッションリプレイの初期化を延期すると、ページ読み込みメトリックに対するSDKの寄与がなくなります。このアプローチは、Time to InteractiveやLargest Contentful Paintなどのロードタイムのメトリクスを測定し、セッションリプレイのインパクトをゼロにする必要がある場合に使用します。 初期化を早めに保ちながら影響を減らすことが目標の場合は、代わりにパフォーマンス最適化の設定オプションを使用してください。
初期化を延期するには、loadイベントリスナーを使用してください:
import 3rdPartyAnalytics from 'example';
window.addEventListener('load', async () => {
const sessionReplay = await import('@amplitude/session-replay-browser');
await sessionReplay.init(AMPLITUDE_API_KEY, {
deviceId: '<string>',
sessionId: '<string | number>',
sampleRate: 0.5,
}).promise;
});
または、requestIdleCallbackを使用してブラウザがアイドル状態になるまで延期します。このアプローチは、アクティビティの少ない瞬間を待機し、他のポストロードワークとの競合を減らします。
import 3rdPartyAnalytics from 'example';
requestIdleCallback(async () => {
const sessionReplay = await import('@amplitude/session-replay-browser');
await sessionReplay.init(AMPLITUDE_API_KEY, {
deviceId: '<string>',
sessionId: '<string | number>',
sampleRate: 0.5,
}).promise;
});
セッションリプレイは、初期化時に完全なDOMスナップショットをキャプチャします。 初期化前に発生したインタラクションは、リプレイには表示されません。
前提条件
セッションリプレイ Standalone SDK には次のことが必要です:
- アプリケーションは Web ベースです。
- 初期化時にセッション識別子を SDK に提供し、それが変更されたときに
setSessionIdを呼び出します。SDK はこの ID を使用してリプレイデータをバケットに格納します。 セッション ID の照合を行うには、アナリティクスイベントと SDK で同じセッション識別子を使用してください。 時間ベースのイベント照合のみの場合、セッションリプレイsessionIdは、フロントエンドで生成されたタイムバケット(たとえば、1時間単位でアラインされたミリ秒単位のUnixタイムスタンプ)であり、アナリティクスイベントには表示されません。 - デバイスIDをSDKに提供できること。
- スタンドアロンSDKに渡す
Device IDは、アナリティクスイベントのデバイスIDと一致している必要があります。
スタンドアロンSDKはセッション管理機能を提供しません。アプリケーションまたはサードパーティの連携で、Session IDおよびDevice IDに対する変更を反映してSDKを更新する必要があります。
クイックスタート
プラグインを npm または yarn でインストールしてください。
Unified SDK
ブラウザ向け統合SDKをインストールすると、実験 SDKに加えて他のAmplitude製品(アナリティクス、セッションリプレイ)も利用できます。Unified SDKは、Amplitudeのすべての機能に単一のエントリポイントを提供し、すべてのコンポーネントの初期化と設定を処理します。
# Install Session Replay SDK only
npm install @amplitude/session-replay-browser --save
# Or install Unified SDK to get access to all Amplitude products
npm install @amplitude/unified
アプリケーションコードを設定します。
- リプレイの収集を開始するには、
sessionReplay.initを呼び出してください。API キー、セッション識別子、デバイス識別子を渡します。 - セッション識別子が変更された場合は、新しい値を
sessionReplay.setSessionIdを使用して Amplitude に渡します。 - Amplitudeは自動的に
[Amplitude] Replay Capturedイベントを作成して、リプレイとアナリティクスデータをリンクさせます。詳細については、『セッションリプレイID』を参照してください。
import * as sessionReplay from "@amplitude/session-replay-browser";
import 3rdPartyAnalytics from 'example'
const AMPLITUDE_API_KEY = "key"
// Configure the SDK and begin collecting replays
await sessionReplay.init(AMPLITUDE_API_KEY, {
deviceId: "<string>",
sessionId: "<string | number>",
optOut: false,
sampleRate: 1, // Records 100% of sessions for initial testing. Lower this for production; the SDK default (0) records nothing.
}).promise;
// Call whenever the session id changes
await sessionReplay.setSessionId(sessionId).promise;
セッションリプレイのインストルメンテーションは、Amplitudeプロジェクトのコンテキスト内で行われます。Amplitudeは、組織レベルでリプレイ割り当てを定義します。 複数のプロジェクトにわたって複数のセッションリプレイの実装が存在する場合があり、それぞれが独自のサンプルレートを持ちますが、同じクォータを消費します。
また、スクリプトタグを使用してセッションリプレイを計測することもできます。
<script src="https://cdn.amplitude.com/libs/session-replay-browser-1.52.0-min.js.gz"></script>
<script>
window.sessionReplay.init(AMPLITUDE_API_KEY, {
deviceId: "<string>",
sessionId: "<string | number>",
sampleRate: 1, // Records 100% of sessions for initial testing. Lower this for production; the SDK default (0) records nothing.
//...other options
})
// Call whenever the session id changes
window.sessionReplay.setSessionId(sessionId);
</script>
セッションリプレイID
Amplitudeは、セッションリプレイがセッションをキャプチャするときに[Amplitude] Replay Capturedイベントを自動的に作成します。このイベントには、リプレイをアナリティクスデータにリンクする[Amplitude] Session Replay IDプロパティが含まれています。 手動による計装は不要です。
[Amplitude] Session Replay ID はリプレイの一意の識別子であり、デフォルトでユーザーのセッションを識別する [Amplitude] Session ID とは異なります。
セッションリプレイ ID の形式は <deviceId>/<sessionId>です。セッションリプレイは区切り文字として/を使用するため、deviceIdとカスタムセッションID文字列値には/を含めることができません。使用できる文字:a-z A-Z 0-9 _ - . | @ : =。追加のキャラクターが必要な場合は、Amplitudeサポートまでお問い合わせください。
Amplitudeは、セッションリプレイIDを使用してリプレイをリンクします。 複数のセッションを1つのリプレイに結合するには、各セッションが同じデバイスIDとセッションIDを参照していることを確認してください。
レガシー実装
getSessionReplayProperties() を使用して [Amplitude] Session Replay ID プロパティをイベントに手動で追加するレガシー実装がある場合、これは引き続き機能します。しかし、Amplitudeは自動[Amplitude] Replay Capturedイベントを推奨しています。
リプレイが表示されませんか?
Amplitude UIにリプレイが表示されない場合は、[Amplitude] Replay Capturedイベントがプロジェクトに表示されていることを確認してください。このイベントが表示されない場合は、Amplitude サポートにお問い合わせください。
設定
セッションリプレイ SDK を初期化する際に、次の設定オプションを渡します。
| 名前 | タイプ | 必須 | デフォルト | 概要 |
|---|---|---|---|---|
deviceId | string | はい | undefined | アプリケーションを実行しているデバイスの識別子を設定します。 |
sessionId | string | number | はい | undefined | ユーザの現在のセッションの識別子を設定します。 標準のセッション追跡にはUnixタイムスタンプ(ミリ秒単位number)を使用するか、カスタムセッション定義にはカスタム文字列を使用します。カスタム文字列値は、受け入れられている文字セットに従う必要があります。 |
sampleRate | number | いいえ | 0 | Amplitudeがリプレイ収集のために選択するセッション数を制御します。 この数値は0から1の小数(例:0.4)で、Amplitudeがリプレイ収集のためにランダムに選択するセッションの割合を表します。セッションが多数ある場合、0.4ではそれらのセッションのうちの40%を選択します。小数点以下6桁(0.000001)までのサンプルレートが有効です。 |
optOut | boolean | いいえ | false | セッションのリプレイを収集するための権限を設定します。 trueの値は、Amplitudeによるセッションリプレイの収集を停止します。 |
flushMaxRetries | number | いいえ | 5 | アップロードの試行に失敗した場合の最大再試行回数を設定します。 これは、Amplitudeが再試行できるエラーにのみ適用されます。 |
logLevel | number | いいえ | LogLevel.Warn | LogLevel.None または LogLevel.Error または LogLevel.Warn または LogLevel.Verbose または LogLevel.Debug。ログレベルを設定します。 |
loggerProvider | Logger | いいえ | Logger | ログメッセージを送信先に出力するように、LoggerからカスタムloggerProviderクラスを設定します。 |
serverZone | string | いいえ | US | EUか米国か。 Amplitudeサーバーゾーンを設定します。 EUデータセンターで作成されたAmplitudeプロジェクトの場合、これをEUに設定してください。 |
privacyConfig | object | いいえ | undefined | CSSセレクターを使用した高度なマスキング設定をサポートします。詳細については、「画面上のデータをマスクする」を参照してください。 |
applyBackgroundColorToBlockedElements | boolean | いいえ | false | trueの場合、ビジュアルマスキングのためにブロックされた要素に背景色を適用します。これにより、Amplitudeがリプレイでのキャプチャからブロックする要素を視覚化できます。 |
debugMode | boolean | いいえ | false | APIキーのハッシュを含む[Amplitude] Session Replay Debugイベントプロパティを追加します。これは、アプリの不一致などのインストルメンテーションの問題のデバッグに役立ちます。Amplitudeは初期設定のデバッグのみにこれを推奨しており、本番環境での使用には推奨していません。 |
configServerUrl | string | いいえ | undefined | リモート設定を取得するためのエンドポイントURLを指定します。指定した場合、デフォルトのサーバーゾーン設定を上書きします。 |
trackServerUrl | string | いいえ | undefined | セッションリプレイデータを送信するためのエンドポイントURLを指定します。このエンドポイントが指定されている場合、SDKはデフォルトのSRエンドポイントではなく、そのエンドポイントにリクエストを転送します。 |
shouldInlineStylesheet | boolean | いいえ | true | Amplitudeがスタイルシートをインライン化している場合、スタイルシートの内容を保存します。 リプレイ中、Amplitudeはリモートで取得する代わりに、保存済みのスタイルシートを使用します。これにより、スタイルシートがないためにリプレイが壊れているように見えることがなくなります。インライン化スタイルシートは、すべての場合に機能するとは限りません。 これが未定義の場合、Amplitudeはスタイルシートをインライン化します。 |
storeType | string | いいえ | idb | Amplitudeがリプレイイベントを保存する方法を指定します。 idb SDKがキャプチャ中にすべてのイベントを送信できない場合に、IndexedDBを使用してリプレイイベントを永続化します。 memory リプレイイベントをメモリにのみ保存するため、ページが閉じられるとイベントは失われます。IndexedDBが使用できない場合、システムはメモリにフォールバックします。 |
performanceConfig.enabled | boolean | いいえ | true | 有効になっている場合、Amplitudeはブラウザのアイドル状態にある間にイベント圧縮が発生するよう遅延させます。 |
performanceConfig.timeout | number | いいえ | undefined | requestIdleCallback APIのオプションのタイムアウト(ミリ秒単位)。この値を指定すると、ブラウザがアイドル状態でない場合でも、遅延圧縮タスクを実行する前にブラウザが待機する最大時間を設定します。 |
useWebWorker | boolean | いいえ | false | Webワーカーを使用して、リプレイイベントを圧縮します。これにより、圧縮をメインスレッドから外すことでパフォーマンスが向上します。 |
APIエンドポイント
ブラウザSDKとプラグインは、次のエンドポイントを使用します。Amplitudeプロジェクトと一致する地域を選択します。
| 目的 | 米国 | 欧州連合 |
|---|---|---|
| リプレイデータの取り込み | https://api-sr.amplitude.com/sessions/v2/track | https://api-sr.eu.amplitude.com/sessions/v2/track |
| リモート設定 | https://sr-client-cfg.amplitude.com/config | https://sr-client-cfg.eu.amplitude.com/config |
ドメインプロキシを設定している場合は、これらのエンドポイントにリクエストを転送してください。デフォルトをtrackServerUrlおよびconfigServerUrlで上書きします。
代替APIエンドポイント
ブラウザのSDKのネットワークに関するガイダンスには、次のエンドポイントファミリーも含まれます。これらのアドレスにリクエストを送信する実装では、対応するドメインをプロキシとCSPの設定に含めてください。
| 目的 | 米国 | 欧州連合 |
|---|---|---|
| リプレイデータの取り込み | https://api-secure.amplitude.com/sessions/track | https://api.eu.amplitude.com/sessions/track |
| リモート設定 | https://api-secure.amplitude.com/sessions/config | https://api.eu.amplitude.com/sessions/config |
画面上のデータをマスクする
セッションリプレイ SDKを使用すると、3通りの方法でユーザー入力、テキスト、およびその他のHTML要素をマスクすることができます。
| エレメント | 概要 |
|---|---|
<input> | デフォルトでは、セッションリプレイはすべてのテキスト入力フィールドをマスクします。ユーザーが入力フィールドにテキストを入力すると、セッションリプレイはテキストの代わりにアスタリスクをキャプチャします。 テキスト入力のマスクを解除するには、.amp-unmaskクラスを追加します。例:<input class="amp-unmask">。 |
| テキスト | 入力要素以外の要素内のテキストをマスクするには、.amp-maskクラスを追加します。たとえば、<p class="amp-mask">Text</p>です。 マスクされている場合、セッションリプレイはマスクされたテキストを一連のアスタリスクとしてキャプチャします。 |
| テキスト以外の要素 | テキスト以外の要素をブロックするには、.amp-blockクラスを追加します。たとえば、<div class="amp-block"></div>です。 セッションリプレイは、ブロックされた要素を同じ寸法のプレースホルダに置き換えます。 |
セッションリプレイのプライバシー設定で、Light、Medium、またはConservativeのマスキングとリモートオーバーライドを設定します。リモート設定がSDK設定と競合する場合、リモート設定が優先されます。
設定時に、privacyConfigオブジェクト内でブロックまたはマスクする要素を指定します。
// This configuration blocks .no-track and #ads, sets the default mask level,
// and defines the mask and unmask selectors.
await sessionReplay.init(AMPLITUDE_API_KEY, {
privacyConfig: {
blockSelector: ['.no-track', '#ads'],
defaultMaskLevel: 'medium',
maskSelector: ['.sensitive-data', '.user-email'],
unmaskSelector: ['.public-info', '#main-content']
}
}).promise;
CSSセレクター
セッションリプレイの設定は、さまざまなタイプのCSSセレクタをサポートしています。要素タグ(h1またはtextarea)、クラス名(.hidden)、またはデータ属性を指定します。
データ属性は、クラス名がハッシュ処理のために頻繁に変更される場合に役立ちます。 データ属性を使用するには、任意の HTML 要素に data-amp-unmaskまたはdata-amp-mask などのカスタム属性を追加します。 たとえば<textarea data-amp-unmask></textarea>のように記述し、その後セレクタを指定する際に属性を角括弧で囲みます:[data-amp-unmask]。
リモート設定
。リモート設定を有効にしてもロードに失敗した場合、セッションリプレイはセッションをキャプチャしません。これにより、管理インターフェイスで定義したプライバシー設定なしでのキャプチャが行われなくなります。
ユーザーのオプトアウト
セッションリプレイにはオプトアウト設定オプションがあります。初期化の一部として渡された場合、これによりAmplitudeはセッションリプレイを収集できません。 例えば:
// Pass a boolean value to indicate a users opt-out status
await sessionReplay.init(AMPLITUDE_API_KEY, {
optOut: true,
}).promise;
コンテンツセキュリティポリシー(CSP)
ウェブアプリケーションで厳格なコンテンツセキュリティポリシーを使用している場合は、実装で使用しているドメインをAPIエンドポイントで許可します。
必要な CSP ディレクティブ
CDN読み込みにはscript-src、取り込みおよびリモート設定にはconnect-src、useWebWorkerを有効にする場合はworker-srcを追加してください。
CSP ディレクティブのリファレンス
| ディレクティブ | ドメイン | 要件 |
|---|---|---|
script-src | https://cdn.amplitude.com | AmplitudeのCDNからブラウザSDKまたはプラグインをロードする際に必須です。 |
connect-src | https://api-sr.amplitude.comおよびhttps://sr-client-cfg.amplitude.com | USリプレイの取り込みとリモート設定。 |
connect-src | https://api-sr.eu.amplitude.comおよびhttps://sr-client-cfg.eu.amplitude.com | serverZone: "EU"の場合は、EUリプレイの取り込みとリモート設定。 |
connect-src | https://api-secure.amplitude.com | 代替のUS APIエンドポイントを使用する実装に必須です。 |
connect-src | https://api.eu.amplitude.com | 代替EU APIエンドポイントを使用する実装に必須です。 |
worker-src | blob: | リプレイイベント圧縮のをuseWebWorkerを有効にしている場合に必須です。 |
CSPヘッダーの例
US取り込みとリモート設定の場合:
Content-Security-Policy: script-src 'self' https://cdn.amplitude.com; connect-src 'self' https://api-sr.amplitude.com https://sr-client-cfg.amplitude.com; worker-src 'self' blob:;
EU取り込みとリモート設定の場合:
Content-Security-Policy: script-src 'self' https://cdn.amplitude.com; connect-src 'self' https://api-sr.eu.amplitude.com https://sr-client-cfg.eu.amplitude.com; worker-src 'self' blob:;
代替USエンドポイントを使用した実装の場合:
Content-Security-Policy: script-src 'self' https://cdn.amplitude.com; connect-src 'self' https://api-secure.amplitude.com; worker-src 'self' blob:;
代替EUエンドポイントを使用した実装の場合:
Content-Security-Policy: script-src 'self' https://cdn.amplitude.com; connect-src 'self' https://api.eu.amplitude.com; worker-src 'self' blob:;
configServerUrlまたはtrackServerUrlでカスタムエンドポイントを指定する場合は、対応するデフォルトドメインの代わりに、これらのドメインをconnect-srcに追加してください。
EU域内のデータレジデンシー
セッションリプレイは、EUデータセンターを使用するAmplitudeのお客様が利用できます。初期化時にserverZone設定オプションを EUに設定します。 例えば:
// For European users, set the serverZone to "EU"
await sessionReplay.init(AMPLITUDE_API_KEY, {
serverZone: "EU",
}).promise;
サンプリングレート
デフォルトでは、セッションリプレイはリプレイ用にセッションの0%をキャプチャします。sampleRate設定オプションを使用して、セッションリプレイがキャプチャするセッション総数の割合を設定します。例えば:
// This configuration samples 1% of all sessions
await sessionReplay.init(AMPLITUDE_API_KEY, {
sampleRate: 0.01,
}).promise;
手動および動的サンプリング、クォータ計画、リモート設定の優先順位については、「セッションリプレイの設定」を参照してください。
リプレイ収集を無効にする
セッションリプレイを有効にした後は、次のいずれかの条件を満たすまでサイト上で実行されます。
- ユーザーがサイトを離れる。
sessionReplay.shutdown()呼び出します。
ユーザーがサイトの制限付きエリアに移動する前にsessionReplay.shutdown()を呼び出し、ユーザーがそのエリアにいる間はリプレイ収集を無効にします。
ユーザーがサイトの制限のないエリアに戻ったときに、sessionReplay.init(API_KEY, {...options}) を呼び出してリプレイ収集を再度有効にします。
また、Amplitude 実験などのフィーチャーフラグプロダクトを使用して、場所などの基準に基づいてリプレイ収集を有効または無効にするロジックを作成することもできます。たとえば、特定のユーザーグループを対象とした機能フラグを作成し、それを初期化ロジックに追加できます。
import * as sessionReplay from "@amplitude/session-replay-browser";
import 3rdPartyAnalytics from 'example'
const AMPLITUDE_API_KEY = <...>
await sessionReplay.init(AMPLITUDE_API_KEY, {
deviceId: <string>,
sessionId: <string | number>,
optOut: <boolean>,
sampleRate: <number>
}).promise;
データリテンション
セッションリプレイは、プライバシーリクエストと削除リクエストにAmplitudeのツールとAPIを使用します。キャプチャを実装する際には、同意ガイダンスを確認してください。
リテンション期間
デフォルトのリテンション、延長されたリテンション、およびリテンションの変更の適用開始日については、セッションリプレイのデータライフサイクルリファレンスを参照してください。
DSAR API
セッションリプレイのデータライフサイクルリファレンスでは、DSAR APIが返すメタデータについて説明しています。
データの削除
ユーザーとプロジェクトの削除動作については、セッションリプレイのデータ削除を参照してください。
ボットフィルター
ボットフィルタリングとプロパティフィルタの制限については、セッションリプレイのボットフィルタリングを参照してください。
セッションリプレイストレージ
セッションリプレイはユーザーのブラウザにクッキーを設定しません。 代わりに、デフォルトでIndexedDBという名前のブラウザのストレージオプションに依存します。このオプションは、ユーザーがブラウザのタブに移動したり、タブを閉じて再開したりするセッション期間中に、継続的なリプレイ収集を可能にします。SDKはIndexedDBに保存されているデータをクリーンアップするため、これらのデータがユーザーのディスクスペースに影響を与えることはありません。
環境がIndexedDBをサポートしていない場合、セッションリプレイはメモリ内ストレージオプションにフォールバックします。メモリ内ストレージは耐久性が低く、ユーザーがブラウザウィンドウを閉じるとデータは失われます。メモリ内ストレージを強制するには、storeType設定オプションを'memory'に設定してください。
ユーザーがサイト上のすべてのクッキーをオプトアウトした場合、optOut設定オプションを使用して、そのユーザーのリプレイ収集を無効にします。
IndexedDBのベストプラクティス
IndexedDBが初期化され、適切に動作することを確認するには:
CSPヘッダーを確認して、制限的すぎないことを確認してください。
default-srcディレクティブおよびscript-srcディレクティブで、必要なソースが許可されていることを確認してください。同じオリジン内でIndexedDB操作を実行します。クロスオリジン制限は、IndexedDB操作をブロックする可能性があります。
ユーザーがIndexedDBをサポートする最新のブラウザを使用していることを確認します。Amplitudeでは、Chrome、Firefox、Safari、Edge、またはOperaの最新バージョンを推奨します。
既知の制限事項
セッションリプレイを実装する際には、次の制限事項に注意してください。
- セッションリプレイは、複数のプロジェクトにわたって 1 人のユーザーからのリプレイを統合しません。 例えば:
- マーケティングサイトとウェブアプリケーションを別々のAmplitudeプロジェクトとして計測し、それぞれでセッションリプレイを有効にすることができます。
- 既知のユーザーがマーケティングサイトから操作を開始し、ウェブアプリケーションにログインします。
- Amplitudeは両方のセッションをキャプチャします。
- 各セッションのリプレイはホストプロジェクトに表示されます。
- セッションリプレイは次のHTML要素をキャプチャできません:
- キャンバス。
- WebGL。
objectFlash、Silverlight、Java などのプラグインを含むタグ。セッションリプレイはobject type="image"をサポートしています。- Lottie アニメーション。
crossOriginIframes.enabled: trueを使用してセッションリプレイ SDK をロードしないクロスオリジン<iframe>要素(Stripe や Google マップなどのサードパーティ製の埋め込みなど)。ファーストパーティ製のクロスオリジンiframeをキャプチャするには、クロスオリジンiframe録画に移動してください。- 認証を必要とするアセット(フォント、CSS、画像など)。
- セッションリプレイは広告ブロッキングソフトウェアと互換性がありません。
トラブルシューティング
欠落している、不完全な、または利用できないリプレイについては、セッションリプレイのトラブルシューティングを参照してください。 取り込みのステータスについては、セッションリプレイ取り込みモニタリングを使用してください。
CSSのスタイル設定がリプレイに表示されない
セッションリプレイは、サイト上のCSSファイルやその他の静的アセットへの参照を保存し、それらの参照を使用してリプレイを再構築します。 ファイルが移動された場合や、認証が必要な場合、Amplitudeが再生の期間中にそれらのファイルをロードできない可能性があります。
- サイト上のアセットが移動または名前が変更されました。 これは、アプリケーションの新しいバージョンをデプロイするときに発生することがあります。
- サイト上のアセットはアクセス制御の背後にあるため、Amplitudeはそれらを取得できません。
CSS読み込みに関する問題を解決するには:
ドメインが一般公開されていることを確認してください。 ローカル環境で作業している場合、Amplitudeは
localhostに保存されているアセットにアクセスできない場合があります。CDNは古いリプレイ用に古いスタイルシートを記録しておく必要があります。同じスタイルシートのコンテンツが時間の経過とともに変化する場合は、アセットのURLに固有の文字列またはハッシュを追加してみてください。例:
stylesheet.css?93f8b89。サーバーの CORS 設定で許可されているドメインのリストに
app.amplitude.comまたはapp.eu.amplitude.comを追加します。外部スタイルシートをセッションリプレイでアクセスできるようにします。 セッションリプレイが外部スタイルシートを確実にキャプチャできるようにするには、コード内の
<link rel="stylesheet">要素にcrossorigin="anonymous"属性を追加してください。これによりブラウザは認証情報を送信せずにCSSをロードするよう指示され、オリジン間でスタイルシートルールにアクセスできるようになります。この属性がない場合、Google Chrome などのブラウザはこれらのルールへのプログラムによるアクセスをブロックします(たとえば、
stylesheet.cssRulesを読み取ろうとする試みは失敗します)。これらの制限により、セッションリプレイがスタイル情報をキャプチャできないことがあり、その結果、ビジュアル再生が不完全または破損する可能性があります。
リプレイの長さとセッション時間が一致しません
場合によっては、リプレイの長さが[Amplitude] Start Sessionおよび[Amplitude] End Sessionイベント間の時間を超えることがあります。これは、ユーザーがブラウザやブラウザのタブを閉じて[Amplitude] End Sessionが発生したものの、Browser SDKとセッションリプレイプラグインがまだそれを処理していない場合に発生します。ユーザーがそのページを再度訪問すると、SDKとプラグインがイベントを処理し、リプレイとともにAmplitudeに送信します。このシナリオは、End Session Client Event TimeとClient Upload Timeの間に不一致が見られる場合に発生したことを確認できます。
セッションリプレイは、以下の理由でAmplitudeに表示されない場合があります。
- コンテンツセキュリティポリシー
- JavaScriptがブロックされる
- 現在のセッションで、ブラウザSDK経由でトリガーされたイベントがない
- サンプリング
コンテンツセキュリティポリシー
セッションリプレイのスクリプトをサイトに追加したら、セッションリプレイのSDKが実行されているページにアクセスし、ブラウザの開発者ツールを開きます。
JavaScriptコンソールに、Content Security Policyテキストを含むエラーメッセージがないかを確認します。例:Refused to connect to 'https://api-secure.amplitude.com/sessions/track' because it violates the document's Content Security Policy。
このエラーを解決するには、サイトのコンテンツセキュリティポリシーを更新して、AmplitudeのAPIへの接続を許可してください。
JavaScriptがブロックされる
ブラウザの拡張機能やネットワークセキュリティポリシーにより、セッションリプレイ SDKがブロックされている可能性があります。ブラウザの開発者ツールを確認して、リクエストが失敗したかどうかを確認し、失敗した場合は、ブロックされたドメインに例外を追加してください。
サンプリング
セッションリプレイのデフォルトsampleRate値は0です。レートをより高い数値に更新してください。 詳細については、サンプリングレートを参照してください。
一部のセッションには、セッションリプレイIDプロパティが含まれていません。
セッションリプレイでは、セッション内のすべてのイベントに[Amplitude] Session Replay IDプロパティがある必要はなく、セッション内の1つのイベントに含まれていれば動作します。セッションリプレイに接続しているソースとは異なるソースを使用してイベントをインストルメントする場合、このプロパティは存在しない場合があります。たとえば、アプリケーションがBrowser SDKではなく、バックエンドのソースからイベントを送信する場合があります。
セッションリプレイ処理エラー
処理の遅延、識別子の不一致、短いセッション、不完全なページインストルメンテーション、期限切れのリプレイについては、セッションリプレイのトラブルシューティングを参照してください。 リテンションルールについては、セッションリプレイのデータライフサイクルリファレンスを参照してください。
これは役に立ちましたか?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.