To set up Mobile Session Replay for iOS:

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

2. Link the Datadog Session Replay library to your project based on your package manager:

   Package manager	Installation step
   CocoaPods	Add pod 'DatadogSessionReplay' to your Podfile.
   Swift Package Manager	Add DatadogSessionReplay library as a dependency to your app target.
   Carthage	Add DatadogSessionReplay.xcframework as a dependency to your app target.

3. Enable Session Replay in your app:

   AppDelegate.swift

   Copy

   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:

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

2. Add the DatadogSessionReplay iOS library as a link-only dependency. For instructions, see the guide.

3. Declare Datadog Session Replay as a dependency:

   build.gradle.kts

   Copy

   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]")
       }
     }
   }
   

4. Enable Session Replay in your app:

   Application.kt

   Copy

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

5. In case you need Material support on Android, call the SessionReplayConfiguration.Builder.addExtensionSupport(MaterialExtensionSupport()) method, available in the Android source set.

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

To set up Mobile Session Replay for React Native:

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

2. 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.

   Copy

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

   Copy

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

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

   If you use the DatadogProvider component:

   App.tsx

   Copy

   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,
       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;
   

   If you use the DdSdkReactNative.initialize method:

   App.tsx

   Copy

   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())
     .catch((error) => { /* handle error */ });
   

4. Enable Session Replay in your app, after initializing the Datadog SDK:

   App.tsx

   Copy

   import { SessionReplay } from "@datadog/mobile-react-native-session-replay";
   
   SessionReplay.enable();
   

5. Define the configuration for Session Replay:

   App.tsx

   Copy

   SessionReplay.enable({
     replaySampleRate: 100, // Session Replay will be available for all sessions already captured by the SDK
   });
   

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

6. (iOS only) Update your iOS pods.

   Copy

   cd ios && pod install
   

7. Rebuild your iOS and Android apps.

All Session Replay SDK versions can be found in Pub.

To set up Datadog Session Replay for Flutter:

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

2. Add the package to your pubspec.yaml:

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

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,
    ),
);

4. 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;