Следующая строка установит трекер и вместе с ним SDK, позволяя вам использовать все функции трекера.

npm i @openreplay/tracker

При создании экземпляра трекера OpenReplay вы можете задать несколько параметров конфигурации, чтобы настроить многие аспекты записи и процесса записи.

Вы должны установить опцию projectKey в конструкторе. Это значение можно получить в вашей панели управления OpenReplay в разделе ‘Preferences > Projects’.

Если ваш сайт является Одностраничным приложением (SPA), используйте следующий код:

import OpenReplay from '@openreplay/tracker';
//...
const tracker = new OpenReplay({
  projectKey: PROJECT_KEY
});
tracker.start(); // returns a promise with session info (sessionID, sessionHash, userUUID)

В противном случае, если ваше веб-приложение Рендерится на сервере (SSR) (например, NextJS, NuxtJS), используйте следующий фрагмент кода. Убедитесь, что tracker.start() вызывается после запуска приложения (в useEffect или componentDidMount).

import OpenReplay from '@openreplay/tracker/cjs';
//...
const tracker = new OpenReplay({
      projectKey: PROJECT_KEY,
});
//...
function MyApp() {
  useEffect(() => { // use componentDidMount in case of React Class Component
    tracker.start(); // returns a promise with session info (sessionID, sessionHash, userUUID)
  }, [])
}

import OpenReplay from '@openreplay/tracker/cjs';
//...
const tracker = new OpenReplay({
      projectKey: PROJECT_KEY,
      ingestPoint: "https://openreplay.mydomain.com/ingest", // when dealing with the self-hosted version of OpenReplay
      capturePerformance: true,
      __DISABLE_SECURE_MODE: true // for local testing
});

Существует набор опций, которые вы можете передать конструктору. Только projectKey является обязательным.

• projectKey: string ID проекта, который вы отслеживаете.
• sessionHash?: string Хеш первоначальной сессии. Это полезно, когда сессии переходят через разные поддомены вашего веб-приложения, но вы хотите объединить их в одну запись. Если продолжение сессии невозможно (она не существует или завершена), трекер автоматически начнет новую. Также возвращается при вызове stop(). Больше деталей об этом здесь.
• ingestPoint?: string Ваш домен OpenReplay (например, https://openreplay.mydomain.com/ingest), на который трекер будет отправлять события. Это необязательно для пользователей OpenReplay Cloud. По умолчанию: https://api.openreplay.com/ingest (указывает на OpenReplay Cloud).
• revID?: string ID ревизии вашего веб-приложения. Полезно при поиске проблем, возникающих в конкретной версии релиза.
• resourceBaseHref?: string Относится к публично доступному домену, откуда активы (стили, шрифты и иконки) могут быть загружены OpenReplay. Поскольку они необходимы для корректного воспроизведения сессии, этот параметр полезен для обхода ограничений, связанных с размещением вашего сайта (и, следовательно, активов) в частном домене. Пример: https://mypublicsite.com/assets/.
• captureIFrames?: boolean Для захвата всех iFrames одного домена в вашем веб-приложении. Если вы хотите отслеживать конкретный iFrame, просто добавьте HTML-атрибут data-openreplay-capture к тегу <iframe>. По умолчанию: true.
• disableClickmaps?: boolean Для отключения вычисления CSS-селекторов (используемых в картах кликов). По умолчанию: false.
• verbose?: boolean Для включения логирования. По умолчанию: false.
• autoResetOnWindowOpen?: boolean Включите эту опцию для сброса sessionID при открытии новой вкладки из вашего приложения. Это перезаписывает метод window.open, чтобы избежать дублирования sessionID из-за общего хранения сессий между вкладками браузера. По умолчанию: false.
• forceSingleTab: boolean Отключает возможность многовкладочной записи, которая объединяет пользовательские сессии, проведенные в нескольких вкладках, в одну запись. Вместо этого, при включении этой опции сессии, захваченные в разных вкладках браузера, будут записываться в отдельные записи. По умолчанию: false.
• disableStringDict: boolean Отключает логику словаря строк (для оптимизации хранения) в записях. По умолчанию: false.
• fixedCanvasScaling: boolean Принудительно отображает изображения canvas с плотностью пикселей 1 вместо devicePixelRatio. (снижает потенциальное качество изображения, чтобы уменьшить итоговый размер). По умолчанию: false.
• disableCanvas?: boolean Отключает запись элементов canvas. По умолчанию: false.
• assistSocketHost?: string Может использоваться для установки конкретного хоста для подключения плагина assist. По умолчанию принимает значение ingestPoint.

• respectDoNotTrack?: boolean Не запускать трекер, если в браузере пользователя включен флаг do-not-track. По умолчанию: false.
• obscureTextEmails?: boolean Затемняет электронные адреса в текстовых элементах. Электронные адреса будут преобразованы в случайную цепочку звездочек. По умолчанию: true.
• obscureTextNumbers?: boolean Затемняет числа в текстовых элементах. Числа будут преобразованы в случайную цепочку звездочек. По умолчанию: false.
• obscureInputEmails?: boolean Затемняет электронные адреса в полях ввода. Значения электронной почты будут преобразованы в случайную цепочку звездочек. По умолчанию: true.
• obscureInputNumbers?: boolean Затемняет числа в полях ввода. Значения чисел будут преобразованы в случайную цепочку звездочек. По умолчанию: false.
• obscureInputDates?: boolean Затемняет даты в полях ввода. Значения дат будут преобразованы в случайную цепочку звездочек. По умолчанию: false.
• defaultInputMode?: 0 | 1 | 2 Режим захвата значений ввода по умолчанию. Соответственно: обычный, затемненный или игнорируемый. По умолчанию: 1 (затемненный).

Обратите внимание, что исключенные данные затемняются или подавляются перед отправкой данных на серверы OpenReplay. Изменения, внесенные в вышеупомянутые опции, не могут быть ретроактивными и будут применяться только к вновь собираемым данным. См. Санитизация Данных для получения дополнительной информации.

• consoleMethods?: Array<'log' | 'info' | 'warn' | 'error' 'debug' | 'assert'> | null Указывает список методов консоли для захвата. По умолчанию: ['log', 'info', 'warn', 'error', 'debug', 'assert']
• consoleThrottling?: number Максимальное количество захватываемых записей консоли в секунду. По умолчанию: 30.

• captureExceptions?: boolean Захват исключений JavaScript и трассировок стека. По умолчанию: true.

• captureResourceTimings?: boolean Записывает временные показатели ресурсов. По умолчанию: true.
• capturePageLoadTimings?: boolean Записывает временные показатели загрузки страницы. По умолчанию: true.
• capturePageRenderTimings?: boolean Рассчитывает метрики рендеринга страницы, такие как Speed Index, Visually Complete или Time To Interactive. Требует captureResourceTimings = true. По умолчанию: true.

• capturePerformance?: boolean Для захвата метрик производительности, таких как частота кадров, потребление ЦП и памяти. По умолчанию: true.

Опция network относится к захвату сетевых запросов и полезной нагрузки для fetch и XHR.

network?: {
    failuresOnly: boolean;
    sessionTokenHeader: string;
    ignoreHeaders: Array<string> | boolean;
    capturePayload: boolean; // make sure you sanitize your data before enabling it
    sanitizer: (RequestResponseData) => RequestResponseData | null;
		captureInIframes: boolean;
  	axiosInstances: AxiosInstance[];
    useProxy?: boolean;
		tokenUrlMatcher?: (url: string) => boolean;
  }

Смотрите Сетевые Опции для примеров и подробностей о том, как скрывать конфиденциальные данные.

Опция canvas относится к захвату элементов canvas/WebGL:

canvas?: {
  disableCanvas?: boolean
  fixedCanvasScaling?: boolean
  useAnimationFrame?: boolean
  fileExt?: 'webp' | 'png' | 'jpeg' | 'avif'
}

Смотрите Canvas и WebGL для информации о том, как включить эту возможность, и для получения дополнительных сведений о доступных опциях.

Опция crossdomain относится к захвату iFrames из разных доменов. Она используется совместно с опцией captureIFrames, которая должна быть установлена в true.

	crossdomain?: {
		/**
		 * Enable cross-domain tracking
		 * @default false
		 * */
		enabled?: boolean
		/**
		 * Used to specify the parent domain, will be '*' by default
		 * (Check your CSP settings)
		 * @default '*'
		 * */
		parentDomain?: string
	}

Смотрите Отслеживание кросс-доменных iFrame для получения дополнительных сведений о том, как захватить iFrame из другого домена.

Опция mouse относится к захвату селекторов для кликов для создания карт кликов.

mouse?: 
  {
  disableClickmaps?: boolean
  minSelectorDepth?: number
  nthThreshold?: number
  maxOptimiseTries?: number
  }

• disableClickmaps?: boolean Полностью отключает вычисление селекторов. По умолчанию: false.
• minSelectorDepth?: number Минимальная длина оптимизированного селектора (по умолчанию 2). Пример: body > div > div > p => body > p
• nthThreshold?: number Количество попыток селектора перед переходом к селекторам nth-child. Это дорогостоящая операция, и она может привести к значительным накладным расходам, не устанавливайте значение выше 2000. По умолчанию: 1000.
• maxOptimiseTries?: number Количество попыток оптимизации и укорочения селектора. По умолчанию: 10 000.

• connAttemptCount?: number Максимальное количество повторных попыток, когда HTTP-запросы трекера не могут достичь бэкенда. По умолчанию: 10.
• connAttemptGap?: number Продолжительность между каждой повторной попыткой (выраженная в мс). По умолчанию: 8000.

• onFlagsLoad callback, используемый для выполнения действия после загрузки feature flags (каждый раз).

 flags?: {
 	onFlagsLoad?: (flags: IFeatureFlag[]) => void
 } 

// ...
interface IFeatureFlag {
  key: string
  is_persist: boolean
  value: string | boolean
  payload: string
}

• __DISABLE_SECURE_MODE?: boolean Для разрешения небезопасного соединения между трекером и бэкендом на сайтах без SSL. Это должно использоваться только в целях разработки. По умолчанию: false.