Session Replay iOS Standalone SDK

This article covers the installation of Session Replay for iOS using the standalone SDK. If you use a provider other than Amplitude for in-product analytics, choose this option.

If your app is already instrumented with an Amplitude iOS SDK, use the Session Replay iOS SDK Plugin.

If you use Segment through their Analytics-Swift SDK and Amplitude (Actions) destination, choose the Segment Plugin.

Before you begin

Use the latest version of the Session Replay SDK above version 0.0.11. For a list of available versions, see the release versions on GitHub.

Session Replay Standalone SDK requires that:

1. Your application runs on iOS or iPadOS.
2. You track sessions with a timestamp, which you can pass to the SDK. You inform the SDK whenever a session timestamp changes.
3. You can provide a device ID to the SDK.
4. The Session ID and Device ID you pass to the Standalone SDK must match those sent as event properties to Amplitude.

The Standalone SDK doesn't provide Session management capabilities. Your application or a third-party integration must update the SDK with changes to Session ID and Device ID.

Supported iOS versions

Session replay supports a minimum target version of iOS 13. Over 91% of Apple devices are running iOS 16 or later, per App Store statistics.

Quickstart

Add the latest version of Session Replay to your project dependencies.

1dependencies: [
2    .package(url: "https://github.com/amplitude/AmplitudeSessionReplay-iOS", .branch("main"))
3]

1.product(name: "AmplitudeSessionReplay", package: "AmplitudeSessionReplay")

1pod 'AmplitudeSessionReplay', :git => 'https://github.com/amplitude/AmplitudeSessionReplay-iOS.git'

Configure your application code.

1. Create a let sessionReplay = SessionReplay() object to begin collecting replays. Pass the API key, and a session identifier and device identifier if available.
2. When the session identifier or device identifier changes, pass the new value to Amplitude with sessionReplay.sessionId or sessionReplay.deviceId, respectively.
3. Collect Session Replay properties to send with other event properties with sessionReplay.additionalEventProperties

 1import AmplitudeSessionReplay
 2import ThirdPartyAnalytics
 3 
 4// Initialize the standalone session replay SDK
 5let sessionReplay = SessionReplay(apiKey: amplitude.apiKey,
 6                                     deviceId: DEVICE_ID,
 7                                     sessionId: SESSION_ID,
 8                                     sampleRate: 0.1)
 9 
10// Track an event
11// Get session replay properties for this session
12var eventProperties = event.eventProperties ?? [:]
13eventProperties.merge(sessionReplay.additionalEventProperties) { (current, _) in current }
14event.eventProperties = eventProperties
15ThirdPartyAnalytics.track(event)
16 
17// Handle session ID changes
18// Whenever the session ID changes
19ThirdPartyAnalytics.setSessionId(deviceId)
20// Update the session ID in session replay
21sessionReplay.sessionId = ThirdPartyAnalytics.getSessionId()
22 
23// Handle device ID changes
24// Whenever the device ID changes
25ThirdPartyAnalytics.setDeviceId(sessionId)
26// Update the device ID in session replay
27sessionReplay.deviceId = ThirdPartyAnalytics.getDeviceId()

Configuration

Pass the following configuration options when you initialize the Session Replay SDK.

Remote configuration

Enable remote configuration to set Sample Rate and Masking Level in Amplitude.

Block on-screen data

Session Replay supports three ways to block sensitive on-screen data.

Mask level

Session Replay for iOS supports three levels of masking, configurable with the the maskLevel config option.

Use this option in the Session Replay configuration.

Privacy methods for UIKit

Session Replay provides an extension on UIView to manage privacy. Import the Session Replay library to access it.

1import AmplitudeSessionReplay

Privacy Modifiers for SwiftUI

Session Replay provides an extension on View to manage privacy. Import the Session Replay Library to access it.

1import AmplitudeSessionReplay

User opt-out

Session Replay provides an option for opt-out configuration. This prevents Amplitude from collecting session replays when passed as part of initialization. For example:

1// Pass a boolean value to indicate a users opt-out status
2        let sessionReplay = SessionReplay(apiKey: API_KEY,
3                                             optOut: true,
4                                             /* other session replay options */)

EU data residency

Session Replay is available to Amplitude Customers who use the EU data center. Set the serverZone configuration option to EU during initialization. For example:

1// Set serverZone to EU
2let sessionReplay = SessionReplay(apiKey: API_KEY,
3                                     serverZone: .EU,
4                                     /* other session replay options */)

Sampling rate

By default, Session Replay captures 0% of sessions for replay. Use the sampleRate configuration option to set the percentage of total sessions that Session Replay captures. For example:

To set the sampleRate consider the monthly quota on your Session Replay plan. For example, if your monthly quota is 2,500,000 sessions, and you average 3,000,000 monthly sessions, your quota is 83% of your average sessions. In this case, to ensure sampling lasts through the month, set sampleRate to .83 or lower.

Keep the following in mind as you consider your sample rate:

• When you reach your monthly session quota, Amplitude stops capturing sessions for replay.
• Session quotas reset on the first of every month.
• Use sample rate to distribute your session quota over the course of a month, rather than using your full quota at the beginning of the month.
• To find the best sample rate, Amplitude recommends that you start low, for example .01. If this value doesn't capture enough replays, raise the rate over the course of a few days. For ways to monitor the number of session replays captured, see View the number of captured sessions.
• Replays with processing errors don't count toward your monthly quota. Replays with a retention error message have already been counted against the quota, when the session was still in the retention period.

1// This configuration samples 1% of all sessions
2let sessionReplay = SessionReplay(apiKey: API_KEY,
3                                     sampleRate: 0.01,
4                                     /* other session replay options */)

Disable replay collection

Once enabled, Session Replay runs on your app until either:

• The user leaves your app
• You call sessionReplay.stop()

Call sessionReplay.stop() before a user navigates to a restricted area of your app to disable replay collection while the user is in that area.

Create a new instance sessionReplay.start() to re-enable replay collection when the return to an unrestricted area of your app.

You can also use a feature flag product like Amplitude Experiment to create logic that enables or disables replay collection based on criteria like location. For example, you can create a feature flag that targets a specific user group, and add that to your initialization logic:

 1import AmplitudeSessionReplay
 2import ThirdPartyAnalytics
 3 
 4let sessionReplay = SessionReplay(apiKey: amplitude.apiKey,
 5                                     deviceId: DEVICE_ID,
 6                                     sessionId: SESSION_ID,
 7                                     sampleRate: 1.0)
 8 
 9if (nonEUCountryFlagEnabled) {
10    sessionReplay.start()
11}

Data retention, deletion, and privacy

Session replay uses existing Amplitude tools and APIs to handle privacy and deletion requests.

Retention period

If your Amplitude plan includes Session Replay, Amplitude retains raw replay data for 30 days from the date of ingestion.

If you purchase extra session volume, Amplitude retains raw replay data for 90 days from the date of ingestion. If you need a more strict policy, contact Amplitude support to set the value to 30 days.

Changes to the retention period impact replays ingested after the change. Sessions captured and ingested before a retention period change retain the previous retention period.

Retention periods are set at the organization level. Replays that are outside of the retention period aren't viewable in Amplitude.

DSAR API

The Amplitude DSAR API returns metadata about session replays, but not the raw replay data. All events that are part of a session replay include a [Amplitude] Session Replay ID event property. This event provides information about the sessions collected for replay for the user, and includes all metadata collected with each event.

 1{
 2  "amplitude_id": 123456789,
 3  "app": 12345,
 4  "event_time": "2020-02-15 01:00:00.123456",
 5  "event_type": "first_event",
 6  "server_upload_time": "2020-02-18 01:00:00.234567",
 7  "device_id": "your device id",
 8  "user_properties": { ... }
 9  "event_properties": {
10    "[Amplitude] Session Replay ID": "cb6ade06-cbdf-4e0c-8156-32c2863379d6/1699922971244"
11  }
12  "session_id": 1699922971244,
13}

Data deletion

Session Replay uses Amplitude's User Privacy API to handle deletion requests. Successful deletion requests remove all session replays for the specified user.

When you delete the Amplitude project on which you use Session Replay, Amplitude deletes that replay data.

Bot filter

Session Replay uses the same block filter available in the Amplitude app. Session Replay doesn't block traffic based on event or user properties.

Session Replay storage

If a user opts out tracking in your app, use the optOut configuration option to disable replay collection for that user.

Session Replay temporarily stores replay data data on the file system before it is uploaded. At every initialization, the least recent replays are trimmed to bring the total disk usage down to a maximum size.

Known limitations

Keep the following limitations in mind as you implement Session Replay:

• Session Replay doesn't stitch together replays from a single user across multiple projects. For example:

  • You instrument multiple apps as separate Amplitude projects with Session Replay enabled in each.
  • A known user begins on one app, and then switch to another.
  • Amplitude captures both sessions.
  • The replay for each session is available for view in the corresponding host project.

• The User Sessions chart doesn't show session replays if your organization uses a custom session definition.

• Session Replay cannot capture the following iOS views:

  • Out-of-process iOS views, such as SFSafariViewController
  • AVPlayerLayer backed views
  • MKMapView
  • WKWebView

Troubleshooting

For more information about individual statuses and errors, see the Session Replay Ingestion Monitor.

Session replays don't appear in Amplitude

Session replays may not appear in Amplitude due to:

• Lack of connectivity
• Sampling
• Sessions not including the Session Replay ID property

Lack of connectivity

Ensure your app has access to the internet then try again.

Sampling

As mentioned above, the default sampleRate for Session Replay is 0. Update the rate to a higher number. For more information see, Sampling rate.

Some sessions don't include the Session Replay ID property

Session replay doesn't require that all events in a session have the [Amplitude] Session Replay ID property, only that one event in the session has it. Reasons why [Amplitude] Session Replay ID may not be present in an event include:

• The user may have opted out or the session may not be part of the sample set given the current sampleRate. Increasing the sampleRate captures more sessions.
• Amplitude events may still send through your provider, but getSessionReplayProperties() doesn't return the [Amplitude] Session Replay ID property. This can result from optOut and sampleRate configuration settings. Check that optOut and sampleRate are set to include the session.

Session Replay processing errors

In general, replays should be available within minutes of ingestion. Delays or errors may be the result of one or more of the following:

• Mismatching API keys or Device IDs. This can happen if Session Replay and standard event instrumentation use different API keys or Device IDs.
• Session Replay references the wrong project.
• Short sessions. If a users bounces within a few seconds of initialization, the SDK may not have time to upload replay data.
• Page instrumentation. If Session Replay isn't implemented on all pages a user visits, their session may not capture properly.
• Replays older than the set retention period (defaults to 90 days).