Configure Statsig Session Replay

​

Conditional Recording

​

Global Targeting Gate

​

Global Sampling Rate

​

Conditional Triggers: Events and Exposures

• Gate Exposures — Trigger based on exposure to a specific gate, optionally filtered by group (e.g., Pass/Fail).
• Experiment Exposures — Trigger based on exposure to a specific experiment, optionally filtered by group (e.g., Test/Control).
• Events — Trigger based on specific logged event, optionally filtered by event values (e.g., “purchase_event” with value “book”).

​

Example Walkthrough

• The Global Targeting Gate session_replay_global_targeting_gate allows all US users and excludes everyone else.
• The Global Sampling Rate is set to 25%, so only 25% of eligible US user sessions are recorded from the start.
• For the remaining 75% of eligible users, session recording can still begin mid-session if a conditional trigger occurs.

1. A US user starts a session. They do not pass the 25% Global Sampling Rate, so their session is not recorded from the beginning.
2. Later, a purchase_event occurs with value book. This event is set up as a conditional trigger with a 50% sampling rate. If this session fails the sampling rate check, recording does not start.
3. A minute later, the user is exposed to the cool_new_feature gate, and the recording begins

​

Initialization - StatsigTriggeredSessionReplay

import { StatsigClient } from "@statsig/js-client";
import { runStatsigTriggeredSessionReplay } from "@statsig/session-replay";
import { runStatsigAutoCapture } from "@statsig/web-analytics";

const client = new StatsigClient(
  sdkKey,
  { userID: "some_user_id" },
  { environment: { tier: "production" } } // optional, pass options here if needed
);
runStatsigTriggeredSessionReplay(client, {
  autoStartRecording: true,
  keepRollingWindow: true,
});
runStatsigAutoCapture(client);
await client.initializeAsync();

import { StatsigProvider, useClientAsyncInit } from "@statsig/react-bindings";
import { StatsigTriggeredSessionReplayPlugin } from "@statsig/session-replay";
import { StatsigAutoCapturePlugin } from "@statsig/web-analytics";

function App() {
  return (
    <StatsigProvider
      sdkKey={YOUR_CLIENT_KEY}
      user={{ userID: "a-user" }}
      loadingComponent={<div>Loading...</div>}
      options={{
        plugins: [
          new StatsigTriggeredSessionReplayPlugin({
            autoStartRecording: true,
            keepRollingWindow: true,
          }),
          new StatsigAutoCapturePlugin(),
        ],
      }}
    >
      <Content />
    </StatsigProvider>
  );
}

​

Initialization Options

• autoStartRecording
  • true: Recording can start automatically after initialization. Global targeting gate and sample rate are respected
  • false: You must manually start recording using startRecording(). This is helpful if you want to start the recording after a set point and block any auto-recording before then
• keepRollingWindow
  • true: Statsig maintains a local rolling window of the last 30 seconds of the session, allowing recordings to include context leading up to a trigger.
  • false: If a conditional trigger occurs, recording begins from that moment onward, with no historical context.

​

Advanced: Forcing a Recording on Demand

• startRecording: Respects both the Global Targeting Gate and Global Sampling Rate. This is useful if you still want to start your recordings after a certain point (e.g. after login) but still take advantage of the Global Sampling Rate
• forceStartRecording: Respects the Global Targeting Gate but is not subject to the Global Sampling Rate. Useful for debugging or when you don’t want to be subjected to the Global Sampling Rate
• stopRecording: Stops the current recording, if one is in progress. Calling this method when no recording is active has no adverse effects. After stopRecording is called, conditional recording triggers will not automatically restart the recording. Only an explicit call to startRecording or forceStartRecording will resume recording.

const sessionReplayClient = new SessionReplay(client);
…

if (someCondition) {
  sessionReplayClient.startRecording();
}

import { startRecording } from '@Statsig/session-replay';
…


startRecording(CLIENT_SDK_KEY)

​

Additional Options

​

Configure Recording Privacy/PII Options

• An element with the class name .rr-block will not be recorded. Instead, it will replay as a placeholder with the same dimensions.
• An element with the class name .rr-ignore will not record its input events.
• All text of elements with the class name .rr-mask and their children will be masked.
• input[type="password"] will be masked by default.

​

Limits

​

4 Hours Per Session or 30 Min Inactive Time

​

Recording Limits

​

Replay Availability Time

​

30 Day Retention