---
title: "Session Replay"
description: "Learn how to enable Session Replay in your mobile app."
url: https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/
---

# Set Up Session Replay for Flutter

Flutter Session Replay is available on **iOS** and **Android**.

[Session Replay](https://docs.sentry.io/product/session-replay.md) helps you get to the root cause of an error or latency issue faster by providing you with a reproduction of what was happening in the user's device before, during, and after the issue. You can rewind and replay your application's state and see key user interactions, like taps, swipes, network requests, and console entries, in a single UI.

By default, the SDK masks text, user input, and non-asset images. Images bundled as assets are not masked unless you set `options.privacy.maskAssetImages = true`. Review [privacy settings](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/privacy.md) for `SensitiveContent` and custom widgets.

## [Pre-requisites](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#pre-requisites)

Make sure your Sentry Flutter SDK version is at least `9.0.0`, which is required for Session Replay. You can update your `pubspec.yaml` to the matching version:

```yaml
dependencies:
  sentry_flutter: ^10.1.0
```

## [Setup](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#setup)

To record replays automatically, set a non-zero sample rate and wrap your root widget with `SentryWidget`. For on-demand recording, see [Manual Control](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#manual-control).

```dart
await SentryFlutter.init(
  (options) {
    options.dsn = 'https://<key>@o<orgId>.ingest.sentry.io/<projectId>';
    options.replay.sessionSampleRate = 1.0;
    options.replay.onErrorSampleRate = 1.0;
  },
  appRunner: () => runApp(
    SentryWidget(
      child: MyApp(),
    ),
  ),
);
```

For more details on the available properties, see the [SentryReplayOptions](https://pub.dev/documentation/sentry_flutter/latest/sentry_flutter/SentryReplayOptions-class.html), which is part of [SentryFlutterOptions](https://pub.dev/documentation/sentry_flutter/latest/sentry_flutter/SentryFlutterOptions-class.html).

## [Verify](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#verify)

While you're testing, we recommend that you set `sessionSampleRate` to `1.0`. This ensures that every user session will be sent to Sentry.

Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping `onErrorSampleRate` set to `1.0`.

## [User Session](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#user-session)

A user session starts when the Sentry SDK is initialized or when the application enters the foreground. The session will capture screen transitions, navigations, touches and other events until the application is sent to the background. If the application is brought back to the foreground within 30 seconds (default), the same `replay_id` will be used and the session will continue.

The session will be terminated if the application has spent in the background more than 30 seconds or when the maximum duration of 60 minutes is reached. You can adjust the [session tracking interval](https://docs.sentry.io/platforms/dart/guides/flutter/configuration/releases.md#sessions) to extend or shorten the duration of a single replay, depending on your needs. Note that if the application exits abnormally while running in the background, the session will also be terminated.

### [Buffered Replays for Errors and User Feedback](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#buffered-replays-for-errors-and-user-feedback)

If you prefer not to record an entire session, you can elect to capture a replay only when an error occurs or when your app captures feedback. In this case, the integration will buffer up to 30 seconds worth of events prior to the trigger. It will continue to record the session, following the rules above regarding session life and activity. For the built-in [SentryFeedbackForm](https://docs.sentry.io/platforms/dart/guides/flutter/user-feedback.md#sentryfeedbackform), the buffer is sent when the form opens, so the replay shows what happened before the user started entering feedback. Read the [sampling](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#sampling) section for configuration options.

## [Sampling](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#sampling)

Sampling allows you to control how much of your app's traffic will result in a Session Replay. There are two sample rates you can adjust to get the replays relevant to you:

1. `sessionSampleRate` - The sample rate for replays that begin recording immediately and last the entirety of a user's session.
2. `onErrorSampleRate` - The sample rate for replays that are recorded when an error happens or when feedback is captured. This type of replay will record up to 30 seconds of events prior to the trigger and continue recording until the session ends.

Sampling starts as soon as a session begins. The `sessionSampleRate` is then evaluated. If the session is sampled, replay recording will start immediately. If not, `onErrorSampleRate` will be evaluated. If the session is sampled at this point, the replay will be buffered and will only be uploaded to Sentry if an error occurs, your app calls `Sentry.captureFeedback()`, or the built-in feedback form opens.

## [Manual Control](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#manual-control)

Available since: `v10.0.0`

Use `SentryFlutter.replay` to control recording for opt-in flows or specific parts of your app. These methods support Android and iOS; they do nothing on other platforms or before `SentryFlutter.init()`.

### [Start Recording on Demand](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#start-recording-on-demand)

To record only when your app explicitly requests it, set both sample rates to zero during initialization. Keep the `SentryWidget` wrapper from [Setup](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#setup): manual recording still needs it to capture your Flutter UI.

```dart
await SentryFlutter.init(
  (options) {
    options.dsn = 'https://<key>@o<orgId>.ingest.sentry.io/<projectId>';
    options.replay.sessionSampleRate = 0.0;
    options.replay.onErrorSampleRate = 0.0;
  },
  appRunner: () => runApp(SentryWidget(child: MyApp())),
);
```

After initialization, start recording when the user opts in or enters the workflow you want to capture:

```dart
await SentryFlutter.replay.start();
```

Explicit starts bypass automatic session sampling. Setting the sample rates to zero does not disable the manual API. Calling `start()` while a replay is already active does nothing.

### [Buffer Until a Trigger](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#buffer-until-a-trigger)

To capture the lead-up to a specific action without uploading an entire session, start a rolling buffer of up to 30 seconds:

```dart
await SentryFlutter.replay.startBuffering();
```

Call `flush()` when your app decides to send the buffer:

```dart
await SentryFlutter.replay.flush();
```

Flushing sends the buffer and continues recording in session mode. An error can also trigger this transition when selected by `onErrorSampleRate`. With `onErrorSampleRate` set to `0.0`, errors do not send the buffer automatically; call `flush()` explicitly.

### [Pause Around Sensitive Content](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#pause-around-sensitive-content)

Call `pause()` before showing sensitive content and `resume()` after hiding it. The paused interval excludes Replay screenshots and touches, and resuming continues the same replay.

```dart
await SentryFlutter.replay.pause();
try {
  await showSensitiveScreen();
} finally {
  await SentryFlutter.replay.resume();
}
```

Here, `showSensitiveScreen()` represents your app's navigation flow and should complete after the sensitive screen closes. Continue to configure [masking rules](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/privacy.md) for recorded content. Pausing Replay does not disable other SDK features, such as error reporting.

### [End or Send a Replay](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#end-or-send-a-replay)

Call `stop()` to end the current replay. Starting again creates a new replay with a new replay ID:

```dart
await SentryFlutter.replay.stop();
// Start a separate replay when your app needs to record again.
await SentryFlutter.replay.start();
```

Use `flush()` to send pending data while continuing to record. In session mode, it sends pending data; in buffer mode, it sends the buffer and switches to session mode. If no replay is active, `flush()` starts a new session, so it is not a shutdown operation.

All manual control methods return `Future<void>`. Await calls in order, especially when stopping and starting another replay. Native recording and uploading continue asynchronously; completion of the future is not confirmation that Sentry has received the replay. Manual replays remain subject to server-side rate limits.

## [PII & Privacy Considerations](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#pii--privacy-considerations)

Personally identifiable information (PII), and privacy are important considerations when enabling Session Replay. The Sentry Flutter SDK masks text, user input, and non-asset images by default. Asset images require `options.privacy.maskAssetImages = true`.

While we have default privacy considerations in place, there are additional settings you might need to configure to fully mask your app's content. We cannot detect the usage of third party widgets such as [FlutterMap](https://pub.dev/packages/flutter_map) so you need to manually configure the privacy configuration to mask the content of these widgets. To learn more about session replay privacy, [read our docs.](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/privacy.md)

## [Error Linking](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay.md#error-linking)

Errors that happen while a replay is running will be linked to the replay, making it possible to jump between related issues and replays. However, it's **possible** that in some cases the error count reported on the **Replays Details** page won't match the actual errors that have been captured. That's because errors can be lost, and while this is uncommon, there are a few reasons why it could happen:

* The replay was rate-limited and couldn't be accepted.
* The replay was deleted by a member of your org.
* There were network errors and the replay wasn't saved.

## Pages in this section

- [Configuration](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/configuration.md)
- [Privacy](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/privacy.md)
- [Performance Overhead](https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/performance-overhead.md)