Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-243 Session Replay retention update #264

Merged
merged 1 commit into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions content/collections/sections/en/session-replay.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Session Replay is available to try on all new Amplitude plans as of February 7,
{{partial:admonition type="note" heading=""}}
Session Replay is **not** enabled by default, and requires instrumentation beyond the standard Amplitude instrumentation.
{{/partial:admonition}}

{{partial:partials/session-replay/sr-retention}}

## Use Session Replay to review user activity

You can launch a session replay from a user’s event stream, inside a chart, or from your homepage. Replays are generally available for viewing five minutes after a session begins.
Expand All @@ -29,7 +32,7 @@ When viewing a session replay from your [homepage](#h_01HFD88N1M03EH9D8VF32QBBYQ

![image-20240109-232506.png](/docs/output/img/session-replay/image-20240109-232506-png.png)

Session replay supports user sessions of any length.
Session Replay supports user sessions of any length.

### View Session Replay from User Look-Up

Expand Down Expand Up @@ -131,7 +134,6 @@ There are some limitations when using Session Replay:
* Session Replay is available for web-based applications only. This includes mobile web. Desktop applications aren't supported.
* Session Replay supports standard session definitions only. [Custom session definitions](/docs/cdp/sources/instrument-track-sessions) aren't supported.
* Session Replay can only be used to segment by users, and isn't available for [account-level reporting](/docs/analytics/account-level-reporting).
* You can replay captured sessions for up to three months (90 days) after they occur. You can request to change this to 30 days, to comply with stricter privacy requirements. If you change your retention period, the changes apply only to new sessions, and not those that pre-date the change.
* If you are in a portfolio view, you can see replays for different users under different projects. However, keep in mind that Session Replay doesn't stitch together replays from a single user across multiple projects. If a user begins a session in one project and then continues to a second project, Amplitude Analytics generates separate replays for that user for each project.
* Session Replay doesn't capture these unsupported HTML elements:
* Canvas
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Amplitude built Session Replay to minimize impact on the performance of web page

Session Replay captures changes to a page's Document Object Model (DOM), including elements in the shadow DOM, then replays these changes to build a video-like replay. For example, at the start of a session, Session Replay captures a full snapshot of the page's DOM. As the user interacts with the page, Session Replay captures each change to the DOM as a diff. When you watch the replay of a session, Session Replay applies each diff back to the original DOM in sequential order, to construct the replay. Session replays have no maximum length.

{{partial:partials/session-replay/sr-retention}}

## Before you begin

Use the latest version of the Session Replay Plugin above version {{sdk_versions:session_replay_plugin}}. For more information, see the [change log](https://github.com/amplitude/Amplitude-TypeScript/blob/v1.x/packages/plugin-session-replay-browser/CHANGELOG.md) on GitHub.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Amplitude built Session Replay to minimize impact on the performance of web page

Session Replay captures changes to a page's Document Object Model (DOM), including elements in the shadow DOM, then replays these changes to build a video-like replay. For example, at the start of a session, Session Replay captures a full snapshot of the page's DOM. As the user interacts with the page, Session Replay captures each change to the DOM as a diff. When you watch the replay of a session, Session Replay applies each diff back to the original DOM in sequential order, to construct the replay. Session replays have no maximum length.

{{partial:partials/session-replay/sr-retention}}

## Before you begin

Use the latest version of the Session Replay standalone SDK above version {{sdk_versions:session_replay_standalone}}. For more information, see the [change log](https://github.com/amplitude/Amplitude-TypeScript/blob/v1.x/packages/session-replay-browser/CHANGELOG.md) on GitHub.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{markdown}}
{{partial:admonition type="tip" heading="Replay retention"}}
By default, Amplitude retains replays for three months. Purchase extra retention and have your replays available for up to 12 months, or contact Amplitude to reduce retention to as little as 30 days.
{{/partial:admonition}}
{{/markdown }}
Loading