Метрики

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

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

  1. Запустите 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
  2. Задайте параметры для работы метрик в образе сервиса 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

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

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

  1. Перейдите в панель администрирования Gramax Enterprise Server на вкладку Настройки → Модули.

  2. Включите модуль метрик.

  3. Откройте любую страницу метрик и проверьте, что страница стала активной.