Определение свойств действий пользователя и пользовательской сессии для веб-приложений

Материал из Документация Ключ-АСТРОМ

Определение свойств действий пользователя и пользовательской сессии для веб-приложений

Ключ-АСТРОМ собирает много информации о производительности вашего веб-приложения. Вы можете обогатить эту информацию ценными метаданными и преобразовать их в свойства действий пользователя и пользовательских сессий.

Свойства действий и сессий представляют собой пары «ключ-значение», которые можно фильтровать в различных представлениях анализа Ключ-АСТРОМ. Эти свойства полезны, когда необходимо создавать мощные запросы, сегментации и агрегации на основе собранных метаданных. Свойства действий и сессий можно использовать для создания вычисляемых метрик приложения. Их также можно увидеть в представлении многомерного анализа, на странице «Пользовательские сессии» и на странице запросов пользовательских сессий. Для более глубокого понимания того, как использовать эти свойства, посетите раздел «Использование свойств действий и пользовательских сессий для веб-приложений».

Ниже вы найдете информацию о том, как настроить такие свойства, а также примеры соответствующей конфигурации. Чтобы использовать свойства действий и сессий, сначала необходимо добавить свойства в веб-интерфейсе Ключ-АСТРОМ, а затем начать передачу необходимых метаданных в Ключ-АСТРОМ.

Добавить пользовательское свойство

Используйте настраиваемые свойства для определения строковых, числовых и датовых параметров отслеживаемых действий и сессий пользователей. Ключ-АСТРОМ затем фиксирует значения свойств в рамках каждого взаимодействия пользователя с приложением. Вы можете использовать значения свойств для получения непревзойденной информации обо всех деталях взаимодействия пользователей с вашим приложением. Вы можете определить пользовательские свойства действий и сессий, специфичные для каждого приложения.

Типы выражений

Ключ-АСТРОМ может собирать метаданные из следующих источников (типы выражений):

  • CSS-селектор
  • переменная JavaScript
  • API JavaScript
  • Функция JavaScript
  • Метатег
  • Значение файла cookie

Требования к значению файлов cookie

Если вы хотите использовать Cookie value в качестве источника данных, убедитесь, что у файлов cookie нет соответствующего атрибута HttpOnly. В противном случае RUM JavaScript не сможет прочитать значения файлов cookie, поскольку HttpOnly файлы cookie недоступны для JavaScript.

  • Строка запроса
  • Атрибут запроса на стороне сервера
  • Заголовок ответа XHR/fetch (доступен с версии RUM JavaScript 1.253 для XHR/fetch и с версии RUM JavaScript 1.257 для Angular)

Требования к заголовку ответа XHR/fetch

Если вы хотите использовать XHR/fetch response header в качестве источника данных, убедитесь в следующем:

  • В настройках приложения включите параметры Захват запросов fetch(), Захват запросов XmlHttpRequest (XHR) или Angular. Подробные инструкции см. в разделах «Активация поддержки универсальных фреймворков JavaScript» или «Активация поддержки Angular».
  • Для AngularJS не поддерживается сбор метаданных из заголовков ответа XHR/fetch.
  • Для запросов CORS и XHR Ключ-АСТРОМ может получать метаданные только из заголовков ответа, содержащих информацию о разрешенных запросах CORS. Если вам нужно извлечь данные из других заголовков, используйте заголовок Access-Control-Expose-Headers.
  • Access-Control-Expose-Headers: Content-Encoding, Destination, Basket-value для отображения указанных заголовков
  • Access-Control-Expose-Headers: * отображать все заголовки, кроме заголовка Authorization для запросов без учетных данных.
  • Access-Control-Expose-Headers: *, Authorization отображать все заголовки для запросов без учетных данных

Типы данных

Ключ-АСТРОМ может сохранять захваченные метаданные в одном из следующих типов данных:

Тип данных Примечание
String Свойства действий и сессий данного типа данных String ограничены 1000 символами перед применением правила очистки.
Number Double или Long
Date Доступно только для типа выражения JavaScript API — метаданные следует получать через RUM JavaScript API.

Типы хранения

Вы можете сохранять метаданные на разных «уровнях хранения».

  • Свойство действия пользователя: Данные хранятся в определенном свойстве на уровне действия пользователя для каждого действия пользователя, где RUM JavaScript может получить метаданные.
  • Свойство пользовательской сессии: В определенном свойстве на уровне сессии хранится самое последнее полученное значение.
  • Оба варианта: Данные хранятся в определенном свойстве как на уровне действий пользователя, так и на уровне сессии.

Определите пользовательское свойство

Для определения пользовательского свойства:

  1. Перейдите в Веб.
  2. Выберите приложение, которое хотите настроить.
  3. В правом верхнем углу страницы обзора приложения выберите Дополнительно (…) > Редактировать.
  4. В настройках приложения выберите Захват > Свойства сессии и действия.
  5. Выберите Добавить свойство > Пользовательское свойство.
  6. Настройте свойство:
    • Выберите тип выражения. При необходимости выберите также тип данных и длину строки.
    • Введите обозначение типа выражения, которое вы хотите использовать, например, атрибут селектора CSS или имя метатега. Для типа атрибута запроса на стороне сервера выберите имя атрибута запроса.
    • Необязательно: Укажите отображаемое имя, которое представляет собой имя свойства, используемого в веб-интерфейсе Ключ-АСТРОМ, например, на странице сведений о сессии или на странице сведений о действии пользователя.
    • Укажите ключ, который представляет собой имя свойства, используемого для идентификации и последующего поиска свойства в USQL и на странице пользовательских сессий.
      • Ключ, использованный ранее, нельзя использовать повторно, пока данные хранятся в вашей среде. Это связано с тем, что захваченные данные по-прежнему ссылаются на старую конфигурацию свойств.
    • Необязательно: Отключайте параметр Не отслеживать в настройках браузера только в том случае, если данный ресурс не содержит информации, позволяющей идентифицировать личность.
      • Эта опция доступна только для определенных типов выражений и в том случае, если вы включили параметр Соответствовать настройкам браузера "Не отслеживать" в разделе конфиденциальности данных настроек вашего приложения.
    • Выберите как минимум один тип хранения — свойство действия пользователя, свойство сессии или оба. Для типа хранения свойства сессии выберите один из типов агрегации.
    • Необязательно: Чтобы ограничить количество захватываемых значений, включите параметр Применить правило очистки и укажите регулярное выражение.
      • Регулярное выражение применяется к захваченному значению: если вы попытаетесь захватить строку, которая, например, имеет длину 1000 символов, будут захвачены только первые 100 символов, и регулярное выражение будет применено к этим 100 символам.

Добавить пакет свойств

Используйте пакеты свойств для связи аналитических данных с информацией о производительности. Это можно сделать, интегрировав в Ключ-АСТРОМ такие инструменты, как веб-аналитика и мониторинг производительности. Доступен широкий выбор пакетов свойств, например, от Adobe, Google, Intercom и Tealeaf.

Чтобы добавить свойство из пакета свойств:

  1. Перейдите в Веб.
  2. Выберите приложение, которое хотите настроить.
  3. В правом верхнем углу страницы обзора приложения выберите Дополнительно (…) > Редактировать.
  4. В настройках приложения выберите Захват > Свойства сессии и действия.
  5. Выберите Добавить свойство > Пакеты свойств, а затем выберите необходимый пакет из выпадающего списка.
  6. В столбце Настройка свойств выберите Добавить для свойств, которые вы хотите добавить, а затем нажмите Далее.
  7. Для каждого из добавленных свойств выберите как минимум один тип хранилища — свойство действия пользователя, свойство сессии или оба.
  8. Выберите Создать свойство.

Примеры свойств действий и сессий

Вот несколько примеров определений, которые работают в нашем тестовом приложении easyTravel.

Пример: статус участника (CSS-селектор)

Свойство member_status отражает статус участника программы лояльности.

Пример: средняя цена поездки на человека (CSS-селектор)

averagepersonprice отображает среднюю стоимость поездки на человека, забронированной через наш портал easyTravel.

Пример: автор (метатег)

Свойство author получает имя разработчика приложения easyTravel из метатега.

Пример: версия приложения (переменная JavaScript)

Строковая переменная JavaScript сохраняет имя пользователя appversion во время сессии.

Пример: извлечение данных из JSON (переменная JavaScript)

Начиная с версии RUM JavaScript 1.295, извлекать данные из JSON возможно. В следующем примере строковая переменная JavaScript захватывает свойство userid объекта JSON, хранящегося в виде строки в sessionStorage.

Чтобы указать, что строку необходимо преобразовать в формат JSON, используйте символ $ перед именем свойства (даже если имя свойства начинается с $, добавьте еще один символ перед ним). В этом примере будет получена строка, хранящаяся в sessionStorage.user, а символ $ указывает, что строку необходимо преобразовать в формат JSON, после чего будет захвачено свойство $userid.

Вариант использования

Вы можете интегрировать Adobe Analytics с Ключ-АСТРОМ, чтобы упростить взаимодействие между различными командами в вашей компании. Чтобы узнать, как это сделать, посетите разделы «Улучшение коммуникации в BizDevOps с помощью Adobe Analytics и Ключ-АСТРОМ» и «Полезные аналитические данные благодаря нашей интеграции с Adobe Analytics и новым веб-ресурсам».

Ограничения

  • В одном приложении можно определить максимум 200 свойств.
  • Для каждого приложения можно задать максимум 20 свойств действий.
  • Свойства действий и сессий данного типа данных String ограничены 1000 символами перед применением правила очистки.
  • В одном приложении можно бесплатно использовать до 20 свойств. Дополнительные свойства потребляют единицы DEM. Дополнительную информацию см. в разделе «Единицы DEM» (обратите внимание на поля «Свойство сессии» и «Свойство действия» в таблице) и «Бесплатный уровень свойств действия и сессии».

Примечания

  • Ключ-АСТРОМ начинает фиксировать свойства действий и сессий только после того, как вы определите эти свойства в настройках приложения.
  • Свойства сессии недоступны для текущих онлайн-сессий. Эти свойства становятся доступны только после завершения сессии.
  • Метаданные собираются в конце действия пользователя.
  • Если вы хотите собирать метаданные в начале действия пользователя, выберите JavaScript API в качестве типа выражения при добавлении пользовательского свойства, а затем используйте RUM JavaScript API для получения необходимых значений, в частности, методов addActionProperties и sendSessionProperties.

Проверка использования квот

Вы можете проверить, сколько свойств вы уже используете и сколько из них вы еще можете добавить.

  1. Перейдите в Веб.
  2. Выберите приложение, которое хотите настроить.
  3. В правом верхнем углу страницы обзора приложения выберите Дополнительно (…) > Редактировать.
  4. В настройках приложения выберите Захват > Свойства сессии и действия.
  5. Прокрутите вниз до раздела Квоты использования свойств.
Источник — https://doc.ruscomtech.ru/index.php?title=Определение_свойств_действий_пользователя_и_пользовательской_сессии_для_веб-приложений&oldid=6410