Setup Session Replay

Configure session replay for your Flutter app with Luciq. Record user sessions to visually reproduce bugs and understand user experience issues.

If you're already using Luciq, but Session Replay isn't included in your current plan, please reach out to us at [email protected]. We would love to enable a custom trial for you and help you set it up.

Min Required SDK Version

Session Replay is supported starting React Native SDK version 12.1.0.

Session Replay Footprint

We're taking several measures to make sure Luciq Session Replay is resource-friendly. To minimize its impact on the device's battery and data consumption:

• The SDK collects your performance data and sends it in batches, at most, once every 6 hours.
• The SDK doesn't perform any network operations while the app is in the background.

  • This means data collected is sent to the server at the beginning of a session if the last server communication took place more than 6 hours ago.

Data Retention

Data retention period changes from plan to plan and can be checked here. This is customizable on the Enterprise plan.

Enabling/Disabling Session Replay

Luciq's Session Replay can be disabled with the following method. This will completely prevent any session replay data from being sent to your dashboard. By default, Session Replay is enabled if it is available in your current plan.

Dart

SessionReplay.setEnabled(true); // Enabled
SessionReplay.setEnabled(false); // Disabled

Logs

All logs are enabled by default, but can be manually disabled/enabled using the below APIs. More details about each log type can be found here.

Network

Dart

SessionReplay.setNetworkLogsEnabled(true); // Enabled
SessionReplay.setNetworkLogsEnabled(false); // Disabled

Luciq Logs

Dart

SessionReplay.setLuciqLogsEnabled(true); // Enabled
SessionReplay.setLuciqLogsEnabled(false); // Disabled

User Steps

Dart

SessionReplay.setUserStepsEnabled(true); // Enabled
SessionReplay.setUserStepsEnabled(false); // Disabled

Screenshots

Dart

Luciq.setReproStepsConfig(sessionReplay: ReproStepsMode.enabled);

Notes on Screenshots

• Adjusting the setReproStepsConfig method's sessionReplay parameter could affect previous configurations and unspecified parameters will revert back to the default values. For more information, please check the example here.

Limits

• Each session contains up to 2MB of compressed logs and 2MB of compressed screenshots.
• Luciq saves sessions up to 50MB worth of data. (for multiple sessions)
• Data is sent through requests with a maximum of 1MB per request.

Privacy options

Private Views

Set certain screens as private, and they will automatically appear with a black overlay covering any screenshot. You can find more details about private views here.

Network Logs Masking

To obfuscate parts of a network request prior to sending it to the dashboard, you can follow the below steps found here.