Включение/выключение ClickHouse

Начиная с версии 10.4, в сервисе онлайн-консультирования Webim появилась возможность пользоваться улучшенным модулем Статистики, работающим на СУБД ClickHouse. Ниже приведены инструкции по включению и отключению ClickHouse и модуля Статистики v2.

N.B.

То, как именно обновляются данные в Статистике v2, зависит от способа наполнения ClickHouse. Подробнее: Режимы подсчёта и обновления статистики.

Важно

Параметры analytics_v2_*, описанные ниже, актуальны начиная с версии 10.8. В версиях 10.4–10.7 использовались прежние имена (clickhouse_stats, stats_v2, dashboard_v2 и др.) — см. описание параметров account config.

Ручная установка и настройка ClickHouse

Установите ClickHouse на отдельном сервере согласно официальной инструкции. Аппаратные требования к серверу можно найти на этой странице.
Установите пароль для пользователя default. Для этого откройте файл /etc/clickhouse-server/users.xml, найдите в нём элемент <password>, находящийся по умолчанию в подразделе <default> раздела <users>. Между тегами элемента <password> введите новый пароль:
```
<users>
<default>
<password>your-password</password>
```
Разрешите пользователю default создавать других пользователей и выдавать им права. Для этого вам необходимо в открытом ранее файле users.xml найти элемент <access_management> и раскомментировать его, приведя к следующему виду:
```
<access_management>1</access_management>
```
В файле конфигурации /etc/webim/db.json.d/db.json допишите в объект "dbs" параметры БД ClickHouse:
```
"stats_root":
  "default": {
    "type": "clickhouse",
    "host": "<DB IP address>",
    "port": 9000,
    "user": "default",
    "password": "<your-password>"
  }
},
"stats": {}
```
Менеджмент БД со стороны сервера будет происходить через пользователя default. Позднее в ClickHouse будет создана учётная запись для Вашего аккаунта в Webim.
Перейдите в account config. Включите параметр analytics_v2_chat_backend_population, после чего перезагрузите Chat Backend.
При необходимости включите параметр analytics_v2_chat_backend_realtime_population и задайте analytics_v2_chat_backend_realtime_population_period (в секундах), чтобы настроить период обновления realtime-данных.
После перезагрузки активируйте нужные вам опции account config для отображения в меню разделов ClickHouse-статистики:
- analytics_v2_stats: модуль Статистики на ClickHouse
- analytics_v2_dashboard: Панель управления на ClickHouse
- analytics_v2_builder: Конструктор отчётов на ClickHouse
Ссылки на новую версию статистики заменят аналогичные ссылки на предыдущую версию.

Отключение ClickHouse

Для отключения ClickHouse достаточно проделать следующие шаги:

Удостоверьтесь, что опции account config, отвечающие за ClickHouse-статистику, выключены (analytics_v2_stats, analytics_v2_dashboard, analytics_v2_builder, analytics_v2_chat_backend_population и analytics_v2_chat_backend_realtime_population).

Параметр analytics_v2_chat_backend_realtime_population_period отдельно отключать не нужно: это числовая настройка периода, а не переключатель.
В файле конфигурации /etc/webim/db.json.d/db.json удалите объекты "stats_root" и "stats".
Перезагрузите Chat Backend.

После этого вы можете отключить сервер ClickHouse:

systemctl stop clickhouse-server