To set up Mobile Session Replay for iOS:

Step 1 - Set up the iOS RUM SDK

Make sure you've set up and initialized the Datadog iOS RUM SDK with views instrumentation enabled.

Step 2 - Declare the Datadog Session Replay as a dependency

Step 3 - Enable Session Replay

import DatadogSessionReplay

SessionReplay.enable(
  with: SessionReplay.Configuration(
    replaySampleRate: sampleRate,
    // Enable the experimental SwiftUI recording
    featureFlags: [.swiftui: true]
  )
)

All Session Replay SDK versions can be found in the Maven Central Repository.

To set up Mobile Session Replay for Kotlin Multiplatform:

Step 1 - Set up the Kotlin Multiplatform RUM SDK

Make sure you've set up and initialized the Datadog Kotlin Multiplatform RUM SDK with views instrumentation enabled.

Step 2 - Add the DatadogSessionReplay iOS library as a link-only dependency

For instructions, see the guide.

Step 3 - Declare Datadog Session Replay as a dependency

kotlin {
  sourceSets {
    commonMain.dependencies {
      implementation("com.datadoghq:dd-sdk-kotlin-multiplatform-rum:[datadog_version]")
      implementation("com.datadoghq:dd-sdk-kotlin-multiplatform-session-replay:[datadog_version]")
    }

    // in case you need Material support on Android
    androidMain.dependencies {
      implementation("com.datadoghq:dd-sdk-android-session-replay-material:[datadog_version]")
    }
  }
}

Step 4 - Enable Session Replay

// in common source set
val sessionReplayConfig = SessionReplayConfiguration.Builder([sampleRate])
  .build()
SessionReplay.enable(sessionReplayConfig)

Step 5 - Set up Material support on Android (Optional)

If your app uses Material on Android, add:

SessionReplayConfiguration.Builder.addExtensionSupport(MaterialExtensionSupport())

All Session Replay SDK versions can be found in the npmjs repository.

To set up Mobile Session Replay for React Native:

Step 1 - Set up the React Native SDK

Make sure you've set up and initialized the Datadog React Native SDK with views instrumentation enabled.

Step 2 - Declare the React Native Session Replay as a dependency

Add the @datadog/mobile-react-native-session-replay dependency, and make sure it matches the @datadog/mobile-react-native version, either through npm or yarn.

npm install @datadog/mobile-react-native-session-replay

yarn add @datadog/mobile-react-native-session-replay

Step 3 - Enable Session Replay

After the Datadog React Native SDK and Session Replay SDK dependencies are imported, you can enable the feature when configuring the SDK.

import { DatadogProvider, DatadogProviderConfiguration } from "@datadog/mobile-react-native";
import {
  ImagePrivacyLevel,
  SessionReplay,
  TextAndInputPrivacyLevel,
  TouchPrivacyLevel,
} from "@datadog/mobile-react-native-session-replay";

const configuration = new DatadogProviderConfiguration(/* ... */)

// Add this function as onInitialization prop to DatadogProvider
const onSDKInitialized = async () => {
  await SessionReplay.enable({
    replaySampleRate: 100, // Session Replay will be available for all sessions already captured by the SDK
    textAndInputPrivacyLevel: TextAndInputPrivacyLevel.MASK_SENSITIVE_INPUTS,
    imagePrivacyLevel: ImagePrivacyLevel.MASK_NONE,
    touchPrivacyLevel: TouchPrivacyLevel.SHOW,
  });
};

const App = () => {
  const navigationRef = React.useRef(null);
  return (
    <DatadogProvider configuration={configuration} onInitialization={onSDKInitialized}>
      {/* App */}
    </DatadogProvider>
  );
};

export default App;

import { DdSdkReactNative, DdSdkReactNativeConfiguration } from "@datadog/mobile-react-native";
import { SessionReplay } from "@datadog/mobile-react-native-session-replay";

const configuration = new DdSdkReactNativeConfiguration(/* ... */)

DdSdkReactNative.initialize(configuration)
  .then(() => SessionReplay.enable({
    replaySampleRate: 100, // Session Replay will be available for all sessions already captured by the SDK
    textAndInputPrivacyLevel: TextAndInputPrivacyLevel.MASK_SENSITIVE_INPUTS,
    imagePrivacyLevel: ImagePrivacyLevel.MASK_NONE,
    touchPrivacyLevel: TouchPrivacyLevel.SHOW,
  }))
  .catch((error) => { /* handle error */ });

During this step, you can also configure multiple privacy levels that apply to Session Replays.

Step 4 - (iOS only) Update your iOS pods.

cd ios && pod install

Step 5 - Rebuild your app

Rebuild your iOS and Android apps

All Session Replay SDK versions can be found in Pub.

To set up Datadog Session Replay for Flutter:

Step 1 - Set up the Flutter plugin

Make sure you have set up and initialized the Datadog Flutter Plugin.

Step 2 - Add the package to your pubspec.yaml

packages:
  # other packages
  datadog_session_replay: ^x.x.x

Step 3 - Enable Session Replay in your DatadogConfiguration

import 'package:datadog_session_replay/datadog_session_replay.dart';

// ....
final configuration = DatadogConfiguration(
    // Normal Datadog configuration
    clientToken: 'client-token',
    // RUM is required to use Datadog Session Replay
    rumConfiguration: RumConfiguration(
        applicationId: '<application-id'>
    ),
)..enableSessionReplay(
    DatadogSessionReplayConfiguration(
        // Setup default text, image, and touch privacy
        textAndInputPrivacyLevel: TextAndInputPrivacyLevel.maskSensitiveInputs,
        touchPrivacyLevel: TouchPrivacyLevel.show,
        // Setup session replay sample rate.
        replaySampleRate: 100.0,
    ),
);

Step 4 - Add a SessionReplayCapture to the root of your Widget tree

Add a SessionReplayCapture widget to the root of your Widget tree, above your MaterialApp or similar application widget.

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  // Note a key is required for SessionReplayCapture
  final captureKey = GlobalKey();

  // Other App Configuration

  @override
  Widget build(BuildContext context) {
    return SessionReplayCapture(
      key: captureKey,
      rum: DatadogSdk.instance.rum!,
      sessionReplay: DatadogSessionReplay.instance!,
      child: MaterialApp.router(color: color, routerConfig: router),
    );
  }
}

To instrument your consolidated web and native Session Replay views for iOS:

1. Ensure you are using version 2.13.0 or higher of the iOS SDK.
2. Enable webview tracking for your mobile application.
3. Enable Session Replay for your web application.
4. Enable Session Replay for your mobile application (see setup instructions above).

To instrument your consolidated web and native Session Replay views for Kotlin Multiplatform:

1. Enable webview tracking for your mobile application.
2. Enable Session Replay for your web application.
3. Enable Session Replay for your mobile application (see setup instructions above).

To instrument your consolidated web and native Session Replay views for React Native:

1. Enable webview tracking for your React Native application.
2. Enable Session Replay for your web application.
3. Enable Session Replay for your mobile application (see setup instructions above).

Note: This feature is not compatible with React Native's New Architecture for Android.

Datadog Session Replay for Flutter does not currently support Web view capture.

Datadog Session Replay for Flutter does not currently support manual recording.

Datadog.verbosityLevel = .debug

If everything is fine, following logs should appear in the Xcode debug console in about 30 seconds after launching the app:

[DATADOG SDK] 🐶 → 10:21:29.812 ⏳ (session-replay) Uploading batch...
[DATADOG SDK] 🐶 → 10:21:30.442    → (session-replay) accepted, won't be retransmitted: [response code: 202 (accepted), request ID: BD445EA-...-8AFCD3F3D16]

Set the verbosity to DEBUG when you initialize the SDK:

import { SdkVerbosity } from "@datadog/mobile-react-native";

...

config.verbosity = SdkVerbosity.DEBUG;

Set the SDKs verbosity to CoreLoggerLevel.debug before you initialize the SDK:

DatadogSdk.instance.sdkVerbosity = CoreLoggerLevel.debug;