BI-выгрузка
BI-выгрузка даёт Power BI, Looker Studio и Metabase доступ только для чтения по SQL к метрикам звонков, очередей, SMS и ИИ вашей компании. Каждый ключ — это пользователь базы данных только для чтения, который видит только строки вашей компании. Пути записи нет.
Откройте Админ > Подключения > BI-выгрузка (/admin/bi-feed). Чтобы видеть параметры подключения, нужно integrations:read, чтобы выпускать и отзывать ключи — integrations:write.
Выпуск ключа
- Нажмите Создать BI-пользователя и задайте Название от 1 до 80 символов, например
Power BI. - Сразу скопируйте Пароль. Он показывается только один раз и не восстанавливается. Если вы его потеряли, отзовите ключ и выпустите новый.
- Используйте Адрес, База данных, Пользователь и пароль в своём BI-инструменте.
В компании может быть 10 активных ключей. Отозвать сразу удаляет пользователя базы данных. Выпуск и отзыв записываются в журнал аудита.
Если в поле Адрес написано «Администратор не указал» или страница отвечает, что функция не настроена, оператор не настроил BI-выгрузку. См. Настройка оператором.
Что видит BI-инструмент
Четыре представления, время в UTC. В каждом представлении есть столбец tenant_id, всегда равный вашей компании.
| Представление | Одна строка на | Основные столбцы |
|---|---|---|
bi_cdr | звонок | call_id, start_time, answer_time, end_time, direction, caller_e164, callee_e164, did, trunk_id, disposition, ring_ms, talk_ms, hold_ms, queue_wait_ms, cost_micros, tags, sip_final_code |
bi_queue | событие очереди | ts, queue_id, call_id, event, agent_extension_id, agent_user_id, wait_ms, position, reason |
bi_sms | SMS или MMS | ts, message_id, conversation_id, direction, status, kind, from_number, to_number, segments, media_count, error_code |
bi_ai | звонок | call_id, start_time, direction, disposition, talk_ms, has_ai_summary, ai_summary_chars, ai_summary |
Ссылки на записи и исходные набранные строки не раскрываются. ai_summary — текст ИИ-сводки звонка, поэтому относитесь к BI-пространству, где он хранится, так же, как к записям разговоров.
Ключ имеет SELECT на эти четыре представления и ни на что больше. Политика строк на каждом представлении оставляет только строки вашей компании, поэтому WHERE, подзапрос или UNION не позволяют её обойти. Пользователь работает только на чтение, а его запросы ограничены (по 60 секунд на запрос, 1 000 000 строк результата).
Подключение инструмента
- Power BI. Используйте HTTP-интерфейс ClickHouse через веб-источник данных с базовой аутентификацией (пользователь и пароль выше). Драйвер не нужен. С тем же пользователем работает ODBC-драйвер ClickHouse или коннектор.
- Looker Studio. Используйте встроенный коннектор MySQL к порту MySQL ClickHouse (9004) с базой данных, пользователем и паролем и отдельным запросом на каждый источник данных. Оператор должен открыть этот порт с TLS.
- Metabase. Добавьте драйвер ClickHouse с открытым кодом в папку
pluginsMetabase (в Metabase Cloud он есть), затем добавьте базу данных ClickHouse с хостом, портом, базой данных, пользователем и паролем.
Представления читают актуальные данные и не материализуются. Для тяжёлых дашбордов фильтруйте по start_time или ts.
Настройка оператором
Серверам, установленным установщиком MonoPbx, настройка не нужна: установщик (а на более старом сервере — следующее
обновление) создаёт пользователя базы данных, который управляет BI-пользователями, сохраняет его пароль вместе с другими
секретами установки и включает фид. Страница BI-фид в консоли показывает BI-фид готов и кнопку
Создать BI-пользователя. Чтобы фид оставался выключенным, добавьте MPBX_BI_FEED=off в .env установки и
перезапустите.
BI-инструменты подключаются к аналитической базе напрямую только через адрес, который публикует оператор (обратный
прокси или правило файрвола только для нужных сетей). До этого страница сообщает об этом, а компании всё равно могут
создавать BI-пользователей и скачивать представления в CSV. Чтобы показать опубликованный адрес на странице, задайте
MPBX_BI_PUBLIC_URL (например, https://bi.example.com) в .env.
Другие установки:
- Docker Compose вручную: снова запустите
mpbx init(он добавляет только недостающие секреты) и стартуйте с-f compose.yaml -f compose.bi-feed.yaml. - Kubernetes:
mpbx initзаписывает пароль в Secret установки; добавьте компонентbi-feedв свой overlay. - Собственная конфигурация: задайте
clickhouse.bi_admin_user,clickhouse.bi_admin_passwordи при необходимостиclickhouse.bi_public_url.
Когда фид выключен, страница BI-фида сообщает об этом одной фразой со ссылкой на это руководство; API отвечает 503
MPBX-API-NOT-CONFIGURED.
API
| Вызов | Право |
|---|---|
GET /api/v1/integrations/bi-feed: параметры подключения, представления и ключи | integrations:read |
POST /api/v1/integrations/bi-feed/credentials с {"label": "Power BI"}: ответ содержит пароль один раз | integrations:write |
DELETE /api/v1/integrations/bi-feed/credentials/{id} | integrations:write |
Ограничения
- Ключ видит все четыре представления.
- Нет экспорта в CSV для установок, которые не могут опубликовать ClickHouse.
- Готовые шаблоны Power BI, Looker Studio и Metabase лежат в репозитории (
docs/guides/bi-feed/).