Начало работы с анализом поведения
Вы можете управлять аналитикой в интерфейсе Kibana. Для начала перейдите в Поиск > Анализ поведения.
Использование анализа поведения состоит из трёх этапов:
- Создайте коллекцию. Коллекция — это логическая группировка событий анализа поведения.
- Настройте интеграцию с интерфейсом.
- Проанализируйте собранные данные.
Коллекции
Это руководство сосредоточено на использовании интерфейса анализа поведения в Kibana для создания и управления коллекциями. Вы также можете использовать API анализа поведения для создания, перечисления и удаления коллекций, а также для отправки событий в коллекцию.
Коллекция — это набор событий анализа поведения.
Первый шаг в настройке анализа поведения — создание коллекции. Для этого в интерфейсе Kibana:
- Перейдите в Поиск > Анализ поведения.
- Выберите Создать коллекцию.
- Внимательно укажите имя коллекции, так как изменить его позже нельзя.
- Выберите Создать.
При создании коллекции мы автоматически создаём представление данных для коллекции. Это позволяет Kibana получать доступ к вашим данным анализа поведения, хранящимся в Elasticsearch.
Это означает, что после интеграции анализа поведения в ваше приложение или веб-сайт вы можете сразу использовать Discover для просмотра событий, настройки фильтров и создания визуализаций с помощью Lens.
После создания коллекции необходимо выполнить интеграцию с интерфейсом.
Интеграция с интерфейсом
Подробные инструкции по интеграции приведены в интерфейсе Kibana. Найдите их на вкладке Интегрировать в разделе Поиск > Анализ поведения > <ваша-коллекция>.
Выберите один из следующих вариантов интеграции:
После интеграции пользователи JavaScript-библиотеки Search UI могут использовать следующую интеграцию для упрощения отправки событий:
Вариант 1: Трекер браузера
Добавьте фрагмент JavaScript в файлы исходного кода вашего веб-сайта или приложения, используя трекер браузера.
Этот подход лучше всего подходит для веб-браузеров. Пользователям Node-приложений и Search UI следует выбрать другой вариант.
Инструкции по началу работы доступны в интерфейсе Kibana.
Выполните следующие шаги:
-
Вставьте фрагмент JavaScript анализа поведения на каждую страницу веб-сайта или приложения, которые вы хотите отслеживать.
<script src="https://cdn.jsdelivr.net/npm/@elastic/behavioral-analytics-browser-tracker@2"></script>
-
Инициализируйте клиент для начала отслеживания событий. Например:
<script type="text/javascript"> window.elasticAnalytics.createTracker({ endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443", collectionName: "my-collection", apiKey: "########", // Optional: sampling rate percentage: 0-1, 0 = no events, 1 = all events // sampling: 1, }); </script> - Отслеживайте события поиска, такие как клики по результатам и сами поиски, используя методы
trackSearchилиtrackSearchClick.
Вариант 2: JavaScript-трекер
JavaScript-клиент доступен в виде пакета NPM. Мы рекомендуем этот подход, если ваше приложение использует JavaScript из пакетов NPM. Это хороший вариант для Node-приложений (приложений на стороне сервера). Аналитика будет включена в ваш пакет.
Это позволит браузеру оптимизировать загрузку JavaScript.
Инструкции по началу работы также доступны в интерфейсе Kibana.
Выполните следующие шаги:
-
Загрузите клиент JavaScript-трекера анализа поведения из NPM:
npm install @elastic/behavioral-analytics-javascript-tracker -
Импортируйте клиент в приложение:
import { createTracker, trackPageView, trackSearch, trackSearchClick } from "@elastic/behavioral-analytics-javascript-tracker"; -
Инициализируйте клиент для начала отслеживания событий:
Используйте метод
createTrackerдля инициализации трекера с вашей конфигурацией. Затем вы можете использовать трекер для отправки событий в Анализ поведения.Пример инициализации:
createTracker({ endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443", collectionName: "my-collection", apiKey: "<api-key>" }); -
Отправьте события Pageview и поведения поиска.
После вызова
createTrackerвы можете использовать методы трекера, такие какtrackPageView, для отправки событий в Анализ поведения.
После интеграции вы должны увидеть события просмотров страниц на вкладке Обозреватель.
Отбор по сеансам
Не всегда нужно отправлять все сеансы в кластер Elastic. Можно использовать отбор по сеансам, добавив параметр отбора в метод createTracker.
Если отбор установлен на 1 (по умолчанию), все сеансы отправят события. Если отбор установлен на 0, никакие сеансы не отправят события.
Вот пример:
createTracker({
// ... tracker settings
sampling: 0.3, // 30% of sessions will send events to the server
}); Интеграция Search UI
Search UI — это JavaScript-библиотека для создания поискового опыта. Используйте плагин анализа Search UI, доступный в NPM, для интеграции анализа поведения с Search UI.
Эта интеграция позволяет отправлять события из Search UI в клиент анализа поведения. Преимущество этой интеграции заключается в том, что вам не нужно настраивать пользовательские события. События, генерируемые Search UI, отправляются автоматически.
Для использования этой интеграции выполните следующие шаги:
- Вставьте Анализ поведения на ваш сайт, используя Вариант 1: Трекер браузера или Вариант 2: JavaScript-трекер.
- Установите
@elastic/search-ui-analytics-plugin, импортировав его в ваше приложение. - Добавьте плагин в конфигурацию Search UI.
Подробную информацию см. в документации плагина анализа Search UI.
Следующие шаги
- Обратитесь к справочнику по API анализа поведения.
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/behavioral-analytics-start.html