Сбор метрик

Модуль метрик помогает понять, как пользователи работают с документацией на портале для чтения: что читают, как долго, какие разделы востребованы, а какие — нет. Эти данные нужны для принятия решений: как улучшать статьи, навигацию и подробность.

Какие есть показатели

Просмотры

Количество просмотров каждой статьи.

Как считается:

При первом входе пользователя на портал.
При каждой смене URL (переход между статьями, разделами).

Зачем смотреть:

Определить самые востребованные статьи.
Увидеть, какие статьи не читают.
Отследить рост или падение интереса к документации после релизов.

Визиты (сессии)

Пользовательские сессии длительностью до 30 минут.

Как считается:

Визит начинается при заходе на сайт.
Если пользователь активен, таймер сессии автоматически продлевается.
При отсутствии активности более 30 минут начинается новый визит.

Зачем смотреть:

Понять, как часто пользователи возвращаются к документации.
Оценить регулярность использования портала.
Отличить разовые заходы от постоянной работы.

Посетители

Уникальные пользователи портала.

Как считается:

Модель уникальности: устройство или браузер.
Один и тот же пользователь с разных устройств будет считаться разными посетителями.
Это не персональная идентификация, метрика подходит для аналитики, а не для отслеживания конкретных людей.

Зачем смотреть:

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

Поисковые запросы

Статистика по пользовательским поисковым запросам. Включает:

Количество выполненных поисков.
Количество уникальных пользователей по каждому запросу.
CTR (Click-Through Rate) — отношение числа кликов по результатам поиска (статьям) к общему количеству выполненных запросов, показывающее, как часто пользователи переходят по результатам.
Самую популярную статью, кликнутую по данному поисковому запросу.
Долю уточнений — показатель того, выполнял ли пользователь повторный запрос для уточнения результата.

Как считается:

Фиксируется при вводе пользователем поискового запроса.

Зачем смотреть:

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

Анализ статей по рейтингу

Статистика по статьям, на которые пользователи переходят из поиска.

Включает:

Самую популярную статью по конкретному поисковому запросу.
Среднюю позицию статьи, по которой был совершен клик, для данного запроса.
Количество кликов по статье из поиска.
CTR (Click-Through Rate) — отношение числа кликов по результатам поиска (статьям) к общему количеству выполненных поисковых запросов. Показатель отражает, как часто пользователи переходят по результатам после ввода запроса.

Как считается:

Фиксируется при клике пользователя на статью или каталог из поисковой выдачи.

Зачем смотреть:

Позволяет понять, по каким запросам приходят пользователи и какой контент они ожидают найти.
Помогает оценить релевантность статьи запросу по CTR и количеству кликов.
Выявляет запросы с показами, но низким CTR — точки для улучшения статей или сниппетов.
Помогает определить приоритетные статьи для обновления и развития.

Как настроить образ для запуска модуля

Запустите PostgreSQL (пример для Docker, но можно использовать любой удобный вам способ):
```
docker run --name gramax-postgres \
  -e POSTGRES_USER={your_db_user} \
  -e POSTGRES_PASSWORD={your_db_password} \
  -e POSTGRES_DB={your_db_name} \
  -p 5432:5432 \
  -d postgres:18-alpine
```

Задайте параметры для работы метрик в образе сервиса enterprise:


Переменная	Описание	Пример значения
`ENTERPRISE_DB_TYPE`	Тип СУБД для подключения. На данный момент существует только `postgres` тип,однако, как и другие поля, он является обязательным..	`postgres`
`ENTERPRISE_DB_USER`	Имя пользователя БД — должно совпадать с POSTGRES_USER при создании контейнера	`postgres`
`ENTERPRISE_DB_PASSWORD`	Пароль пользователя БД — должен совпадать с POSTGRES_PASSWORD при создании контейнера	`postgres`
`ENTERPRISE_DB_HOST`	Адрес хоста, где запущена БД	`localhost`
`ENTERPRISE_DB_PORT`	Порт, на котором слушает PostgreSQL	`5432`
`ENTERPRISE_DB_NAME`	Имя базы данных — должно совпадать с POSTGRES_DB при создании контейнера	`metrics`

Проверьте запуск сервиса: при старте приложение подключится к БД, создаст таблицы и выполнит миграции.

Как включить модуль метрик в приложении

Перейдите в панель администрирования Gramax Enterprise Server на вкладку Настройки → Модули.
Включите модуль метрик.
Откройте любую страницу метрик и проверьте, что страница стала активной.

Обучение

Первый вход