uba-tool-js

Uba-tool - библиотека для записи событий для uba-tool

Пример базового использования:

import { Recorder, IRecorderConfig } from 'package-name';

const RecorderConfig: IRecorderConfig = {
  application: {
    name: 'uba-tool',
  },
  apiKey: '10qjm289y4i5ub1u9io285', // Можно взять в нашем приложении
};

const recorder = new Recorder(SessionRecorderConfig);

Параметры настроек рекордера

1. Настройки рекордера
2. Кастомные события
3. Когорты
4. Фича-флаги

Настройки рекордера

Настройка записи событий

Name	Type	Default	Description
apiKey	string	none	Ключ для доступа к приложению
application	IApplication	none	Информация о приложении
autocapture?	IAutoCapture	ниже	Базовые настройки рекордера?
mode?	"dev" | "debug" | "prod"	"dev"	WIP: Режим работы рекордера. Нужно для логирования
customEvents?	ICustomEvent[]	[]	Записывать ли ивенты для реплея?
environment?	string	none	Среда работы рекордера?
features?	Array	[]	Список фича-флагов для добавления в приложение

IApplication

Name	Type	Default	Description
name	string	none	Имя приложения, уникально для вашего аккаунта
cohorts	ICohort	none	Когорта - группа пользователей по фильтрам в сессии

ICohort

Name	Type	Default	Description
title	string	none	Название когорты
color?	string	#ffffff	Акцентный цвет текста когорты (Hex)
background?	string	#ffffff	Задний фон когорты (Hex)
filters	{search: string}	none	Фильтры для сортировки пользоватлей по когортам. location.search, но без "?" в начале
features?	Array	[]	Пресет фич для когорты

ICustomEvent

Name	Type	Default	Description
title	string	none	Значения дата атрибута data-uba-event
hmltType	string	none	Тип html-ивента

Для работы пользовательских событий необходимом прописать дата атрибут data-uba-custom-event целевому элементу и прописать такой же в настройках

<input data-uba-custom-event="Comment" />

IAutoCapture

Name	Type	Default	Description
replay	boolean	true	Разрешить запись реплея
enablePageViews	boolean	true	Разрешить детектить смену страницы
enableSessionRecording	boolean	true	Разрешить запись сессии
fileDownloads	boolean	true	[Не используется] Разрешить отслеживать загрузки
eventsDisableList	"click" | "mousemove" | "scroll" | "sumbit" | "input"	["click", "mousemove", "submit", "scroll"]	Запрещенные для записи события
urlsDisableList	Array	[]	Запрещенные пути для записи
tagsDisableList	"BUTTON" | "INPUT" | "FORM" | "TEXTAREA" | "A" | "SELECT" | "LABEL"	[]	Запрещенные для записи теги
enabledDangerousElements	"password" | "email"	[]	Разрешенные опасные элементы

Кастомные события

Для записывания кастомных элементов нужно указать название в дата атрибутах для целевых событий и тип события:

data-uba-event="Custom Event" # Название ивента

<form data-uba-event="Login">
  <input placeholder="Почта" />
  <input placeholder="Пароль" />
  ...
  <input data-uba-event="Delete account" placeholder="Удалить аккаунт" />
</form>

Когорты

Когорты - это пресет фильтров(search string, фичи, страна и т.д.), по которым можно идентифицировать группу пользователей

Feature-flags

Фича-флаги позволяют отсортировать сессии по наличию той или иной фичи и проводить более точные A/B тесты