@amplitude/segment-session-replay-plugin

This package is a wrapper to facilitate integration between Segment and Amplitude's Session Replay SDK. This package currently only supports the Segment Amplitude (Actions) destination.

Installation

This package is published on NPM registry and is available to be installed using npm and yarn. Amplitude's Session Replay SDK is included in this package, and does not need to be installed separately.

# npm
npm install @amplitude/segment-session-replay-plugin --save

# yarn
yarn add @amplitude/segment-session-replay-plugin

Usage

import { AnalyticsBrowser } from '@segment/analytics-next';
import { createSegmentActionsPlugin } from '@amplitude/segment-session-replay-plugin';

export const SegmentAnalytics = AnalyticsBrowser.load({
  writeKey: SEGMENT_API_KEY,
});

createSegmentActionsPlugin({
    segmentInstance: SegmentAnalytics,
    amplitudeApiKey: AMPLITUDE_API_KEY,
    sessionReplayOptions: {
        logLevel: 4,
        sampleRate: 1,
        debugMode: true,
    },
    enableWrapperDebug: true,
});

SegmentAnalytics.track("Immediate Event");

The sessionReplayOptions parameter properties match those documented for the Session Replay Standalone SDK.

Segment Plugin Architecture

This wrapper makes use of Segment's plugin architecture, which ensures that all track and page events are decorated with the Session Replay ID event property.

User ID to Device ID mapping

Following Segment's documentation, the wrapper maps the Segment user id to the Amplitude device id. To determine the device id for session replay captures, the wrapper uses the anonymousId unless sessionReplayOptions.deviceId is provided.