# ClickHouse и аналитика

Подключение к ClickHouse: база статистики, база BI-отчётов и параметры выгрузки данных из PostgreSQL в ClickHouse.

Как изменить параметры и применить изменения, описано в разделе [Параметры .env](https://webim.ru/kb/11.0/settings/env/).

## Статистика { #stats }

| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| `STATS_DATABASE_DEFAULT_URLS` | Список через запятую | Не задано | Да | Адреса узлов ClickHouse с базой статистики в формате `clickhouse+native://<пользователь>:<пароль>@<хост>:<порт>/{database}`. Вместо `{database}` подставляется имя базы из `STATS_DATABASE_TEMPLATE`. Запросы распределяются между узлами случайным образом, изменения схемы выполняются на всех узлах.<br>Пример: `clickhouse+native://webim:<пароль>@ch1.example.local:9000/{database}`. |
| `STATS_DATABASE_TEMPLATE` | Строка | Не задано | Да | Имя базы статистики, например `stats`. Одна база используется для всех аккаунтов: данные разделяются по идентификатору аккаунта. |
| `STATS_CLUSTER_NAME` | Строка | Не задано | Да | Имя кластера ClickHouse, на котором создаются таблицы статистики. |
| `STATS_POPULATE_INTERVAL_MINUTES` | Целое число, минуты | `15` | Нет | Период регулярной выгрузки данных статистики в ClickHouse. Минимальное значение — `1`. |
| `STATS_REALTIME_POPULATE_INTERVAL_SECONDS` | Целое число, секунды | `180` | Нет | Период обновления статистики реального времени (текущих обращений и статусов операторов). Минимальное значение — `10`. |
| `STATS_REALTIME_POPULATE_LOCK_TTL_SECONDS` | Целое число, секунды | `120` | Нет | Время жизни блокировки, которая не даёт запустить обновление статистики реального времени параллельно. |
| `ECHO_SQL` | Логический | `False` | Нет | Только для разработки: запись в журнал всех SQL-запросов к базе статистики. |

## BI-отчёты { #bi }

| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| `CLICKHOUSE_BI_DATABASE_URL` | URL | Не задано | Нет | Адрес подключения к базе BI-отчётов в формате `clickhouse://<пользователь>:<пароль>@<хост>:<порт>/<база>`, где порт — порт native-протокола (по умолчанию `9000`). Для TLS-подключения добавьте к адресу `?secure=true` или задайте `CLICKHOUSE_SSL_CA_LOCATION`. Если параметр не задан, BI-отчёты недоступны. |
| `CLICKHOUSE_BI_HTTP_PORT` | Целое число | `8123` | Нет | HTTP-порт ClickHouse с базой BI-отчётов. Используется при создании таблиц BI-отчётов командой `setup_bi_tables`. |
| `BI_MAX_EXECUTION_TIME` | Целое число, секунды | `5` | Нет | Максимальное время выполнения запроса BI-отчёта в ClickHouse. |
| `BI_CH_QUERY_TIMEOUT` | Дробное число, секунды | `15.0` | Нет | Максимальное время ожидания ответа ClickHouse на запрос BI-отчёта. |
| `BI_CH_POOL_MIN_SIZE` | Целое число | `1` | Нет | Минимальное число соединений пула запросов BI-отчётов в процессе. |
| `BI_CH_POOL_MAX_SIZE` | Целое число | `6` | Нет | Максимальное число соединений пула запросов BI-отчётов в процессе. |
| `BI_KAFKA_TASK_TTL_MINUTES` | Целое число, минуты | `10` | Нет | Срок актуальности задач выгрузки данных BI-отчётов: задача, не выполненная за это время после отправки, отбрасывается. |
| `KAFKA_TTL_BI_REBUILD_HOURS` | Целое число, часы | `1` | Нет | Срок актуальности задач пересборки данных BI-отчётов. |
| `BI_CACHE_CURSOR_TTL_MINUTES` | Целое число, минуты | `10` | Нет | Срок хранения в кэше позиции, с которой продолжается выгрузка данных BI-отчётов. |
| `BI_ARCHIVE_CURSOR_TTL_HOURS` | Целое число, часы | `24` | Нет | Срок хранения в кэше позиции выгрузки архивных данных BI-отчётов. |
| `BI_LIVE_FRESHNESS_THRESHOLD_MINUTES` | Целое число, минуты | `15` | Нет | Если данные BI-отчётов реального времени не обновлялись дольше этого времени, проверка работоспособности `/health` сообщает о проблеме. |

## Общие параметры подключения { #connection }

| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| `CLICKHOUSE_DATABASE_URL` | URL | Не задано | Нет | Адрес подключения к основной базе ClickHouse в том же формате, что и `CLICKHOUSE_BI_DATABASE_URL`. В **Webim** 11.0 используется только для проверки подключения: командой `check_connectivity` и проверкой работоспособности `/health`. |
| `CLICKHOUSE_SSL_CA_LOCATION` | Путь к файлу | Пусто | Нет | Путь к сертификату удостоверяющего центра (PEM). Если задан, подключение к базам `CLICKHOUSE_DATABASE_URL` и `CLICKHOUSE_BI_DATABASE_URL` выполняется по TLS с проверкой сертификата. |
| `CLICKHOUSE_CONNECT_TIMEOUT` | Целое число, секунды | `3` | Нет | Тайм-аут подключения к базам `CLICKHOUSE_DATABASE_URL` и `CLICKHOUSE_BI_DATABASE_URL`. |
| `CLICKHOUSE_SEND_RECEIVE_TIMEOUT` | Целое число, секунды | `10` | Нет | Тайм-аут обмена данными с базами `CLICKHOUSE_DATABASE_URL` и `CLICKHOUSE_BI_DATABASE_URL`. |

---

Источник: https://webim.ru/kb/11.0/settings/env/clickhouse.html
