Настройка RestFS

• RestFS — компонент, обеспечивающий HTTP API для работы с файлами.
• GlusterFS — распределенная файловая система, обеспечивающая надежное хранилище (необязательный компонент для систем без резервирования).

На уровне системы существует реестр кластеров RestFS, с которыми может работать система.
По умолчанию в реестре кластеров RestFS есть кластер default, который отображается в URL: http://system.restfs.ecss:9990

Имя кластера RestFS может быть любым, кроме system, а так же не может начинаться на:

• "http://";
• "https://";
• "ftp://";
• "file://".

Кластер RestFS с именем default не может быть удален.

На уровне системы команды по управлению/мониторингу RestFS располагаются по пути /restfs.

На уровне виртуальной АТС — /domain/<DOMAIN>/restfs/.

Настройки RestFS для одной ноды

Для запуска RestFS в режиме одной ноды достаточно поставить пакет ecss-restfs. В ходе установки буден задан ряд вопросов. Далее, нужно запустить и проверить состояние сервиса restfs.

sudo apt install ecss-restfs
sudo systemctl start ecss-restfs.service
sudo systemctl status ecss-restfs.service

По умолчанию сервис ожидает HTTP-запросы на порту 9990 и работает с каталогом /var/lib/ecss/restfs.

Настройки RestFS для кластера на базе glusterfs-сервера

sudo systemctl start ecss-restfs.service

sudo gluster volume ecss_volume start force

sudo gluster volume set ecss_volume cluster.favorite-child-policy size

Сервис фоновой конвертации записанных разговоров в MP3

Описание

Сервис запускается в определенное время и конвертирует файлы с расширением "wav" в "mp3". Для конвертации используется приложение ffmpeg.

Настройка

Управление сервисом осуществляется командой dpkg reconfigure ecss-restfs, где в ходе настройки пакета задаётся соответствующий вопрос о требовании включения конвертации записей.

Настройку через конфигурационные файлы следует использовать только в том случае, если вы точно знаете, что делаете. Для настройки сервиса необходимо выставить нужные опции в файле /etc/ecss/ecss-restfs/crawler.json:

Настройка Пути

"dirs": {
    "workdir": "/var/lib/ecss/restfs",
    "excluded": [
      "system",
      "domain/*/asr",
      "domain/*/sounds"
    ]
  },

• dirs.workdir — папка, относительно которой производится поиск аудиофайлов (рабочая папка restfs);
• dirs.excluded — папки, которые исключаются из поиска;

Настройка конвертации

Файл содержит параметры, передаваемые конвертору:

  "files": {
    "wav": {
      "enabled": "true",
      "opt": "-v 0 -y",
      "convert": "-vn -ab 192 -ac 1",
      "ext": "mp3"
    },
    "pcm": {
      "opt": "-f s16le -ar 8k -ac 1  -v 0 -y",
      "convert": "",
      "ext": "wav"
    }

• files.wav — описание правил конвертации wav-файлов;
• files.wav.enabled — флаг, показывающий включена ли конвертация wav в mp3;
• files.wav.opt — опции для ffmpeg, с которыми запускается конвертация для wav-файлов;
• files.wav.convert — команда для ffmpeg для конвертации wav-файла;
• files.wav.ext — расширение, с которым сохраняется конвертированный файл;
• files.pcm — описание правил конвертации pcm-файлов;
• files.pcm.opt — опции для ffmpeg, с которыми запускается конвертация для pcm-файлов;
• files.pcm.convert — команда для ffmpeg для конвертации pcm-файла;
• files.pcm.ext — расширение, с которым сохраняется конвертированный файл.

• opt — опции для входного файла;
• convert — опции для выходного файла (конвертированного).

    "transcribe": {
        "enabled": "false",
        "statistics": "false",
        "ext": "vtt" 
    }

• transcribe — описание для транскрибирования (распознавания сохраненных записей разговоров);
• transcribe.enabled — флаг, показывающий включено ли транскрибирование;
• transcribe.statistics — флаг, показывающий включен ли подсчет количества распознанных файлов за один запуск транскрибирования;
• transcribe.ext — расширение, с которым сохраняется распознанный результат (по умолчании vtt — файл субтитров).

Таймер

/lib/systemd/system/ecss-restfs-crawler.timer

По умолчанию конвертация запускается ежедневно в 00:00. Пример настроек:

sasha@ecss1:~$ sudo systemctl cat ecss-restfs-crawler.timer 
# /lib/systemd/system/ecss-restfs-crawler.timer
[Timer]
OnCalendar=00:00

[Unit]
Description=Run conversion every day in 00:00

[Install]
WantedBy=multi-user.target

где:

• Поле OnCalendar — содержит время запуска.

Изменить настройки таймера можно с помощью команды:

sudo systemctl edit ecss-restfs-crawler.timer

Синтаксис настройки таймера приведен в документации по команде man systemd.timer. 

Права

/lib/systemd/system/ecss-restfs-crawler.service

Данный файл содержит следующие параметры:

• Пользователь, от чьего имени выполняется сервис (User, Group);
• Права на новые файлы (Umask);
• Время жизни сервиса (RuntimeMaxSec);
• Ограничение на ресурсы (CPUQuaota, Nice).

Настройка сервиса tts для работы с Yandex-Speechkit (Text-to-Speech)

TtS (Text-to-Speech) — сервис синтеза речи, работающий с Yandex-Speechkit , позволяющий озвучить любой текст на нескольких языках.

Настройка в Yandex Облако

Добавление дополнительного профиля Яндекс.Облако

Для добавления дополнительного профиля Яндекс.Облако нужно отправить http-запрос:

curl localhost:9990/generate?OAuth=<OAuth_токен>&folderId=<folderId>

Для немедленного обновления IAM-токена нужно отправить следующий http-запрос:

curl localhost:9990/generate?OAuth=<OAuth_токен>&folderId=<folderId>&update_key=True

Настройка сервиса tts для работы с Eltex TTS

Eltex TTS — сервис синтеза речи, предоставляемый приложением ASR (документация), так же как и Yandex-Speechkit, позволяет озвучить любой текст, но только на русском языке с возможностью выбора одно из нескольких голосов.

Настройка Eltex TTS во время установки или реконфигурирования RestFs

Команда для установки ecss-restfs:

sudo apt install ecss-restfs

Команда для реконфигурирования ecss-restfs:

sudo dpkg-reconfigure ecss-restfs

Для работы сервиса Eltex TTS необходимо во время установки/реконфигурирования настроить следующие параметры:

1. Ответьте «Yes» на вопрос "Необходимо ли использование сервиса Text To Speech" (рисунок 1):

Рисунок 1 — Вопрос о необходимости использования сервиса Text To Speech

2. Выберите Eltex TTS сервис (рисунок 2):

Рисунок 2 — Выбор поддерживаемого сервиса Text To Speech

3. Укажите адрес и порт сервиса Eltex TTS (рисунок 3):

Рисунок 3 — Настройка адреса и порта сервиса Eltex TTS

4. Выберите желаемый голос для синтеза речи (рисунок 4):

Рисунок 4 — Выбор голоса сервиса Eltex TTS

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

Настройка распределенного хранилища

В системе ECSS-10 реализованы сервисы, которые в процессе своей работы формируют данные и сохраняют их на дисковое пространство. Такими сервисами являются:

• услуга "Запись разговоров" (Call recording);
• услуга передачи факса (Fax);
• услуга "Голосовая почта" (Voicemail).

Данные сервисы генерируют файлы и работают с дисковыми хранилищами.

Под распределенным хранилищем подразумевается возможность сохранять записанные файлы на разные хосты.

Рисунок 5 — Пример распределенного хранилища

Каждое хранилище состоит из следующих элементов:

• RestFS — компонент, обеспечивающий интерфейс прикладного программирования HTTP API для работы с файлами.
• GlusterFS — распределенная файловая система, обеспечивающая надежное хранилище (необязательный компонент для систем без резервирования).

Количество распределенных хранилищ не ограничено, возможно совмещение всех хранилищ на одном хосте. В базу данных сохраняется полный URI для записанного файла, поэтому, например, при прослушивании записи разговора из web-интерфейса, система обратится на сервер, идентифицируемый данным URI в базе данных.

Распределенная файловая система glusterfs автоматически синхронизирует файлы между нодами кластера. Таким образом, в кластерном варианте работы сервис при проблемах с одним из серверов автоматически будет делать попытку записи файла либо попытку его считывания с другого сервера.

Дисковое хранилище может работать в двух режимах:

• Простой режим (Single mode) — в данном режиме все типы данных (записи разговоров, факсы, файлы голосовой почты) отправляются в одно файловое хранилище. Для настройки данного режима достаточно настроить сервис RestFS.
• Распределенный режим (Distributed mode) — в данном режиме все типы данных (записи разговоров, факсы, файлы голосовой почты) отправляются в разные файловые хранилища. Распределенный режим предполагает, что пакет ecss-restfs, обеспечивающий программный интерфейс HTTP API, будет установлен на несколько хостов. Перед установкой пакета необходимо убедиться, что имя хоста "hostname", на который ставится пакет, не равно ecss1 или ecss2. В противном случае может возникнуть конфликт с нодами restfs, которые запущены на хостах системы ECSS-10 локально.

Порядок настройки дискового хранилища в распределенном режиме

1. Установите пакет restfs. Для этого необходимо выполнить следующую команду:

   sudo apt install ecss-restfs
   

2. После установки пакета сконфигурируйте параметры listen_port и listen_ip таким образом, чтобы подсистема restfs находилась в одной сети с системой ECSS-10. Для этого выполните настройку ноды согласно Настройка RestFS.

3. Произведите изменения в конфигурационных файлах.

   Необходимо проверить, и при необходимости настроить параметр MYSQL_IP в файле ecss-cocon-mysql:

   /etc/dnsmasq.d/ecss-cocon-mysql:
   address=/cocon.mysql.ecss/<MYSQL_IP>

   и параметры ECSS_1_IP и ECSS_2_IP в файле ecss-broker:

   /etc/dnsmasq.d/ecss-broker: 
   address=/primary.broker.ecss/<ECSS_1_IP> 
   address=/secondary.broker.ecss/<ECSS_2_IP>

   где:

   • MYSQL_IP — виртуальный адрес для доступа к mysql;
   • ECSS_1_IP — ip-адрес ноды ecss1, на котором слушает сервис mycelium;
   • ECSS_2_IP — ip-адрес ноды ecss2, на котором слушает сервис mycelium;

4. Перезапустите сервисы dnsmasq и ecss-restfs.

   Для этого выполните следующую команду:

   sudo systemctl restart ecss-ds.service ecss-restfs.service

5. После настройки и подключения нужного количества нод restfs укажите системе ECSS-10, в какую ноду будет сохраняться тот или иной тип данных. Для этого необходимо выполнить требования раздела «Конфигурирование URL для доступа к распределенному хранилищу».

Конфигурирование URL для доступа к распределенному хранилищу

1. Сконфигурируйте соотношение выделенных имен для хранилища на DNS-сервере (при использовании DNS-сервера) либо в локальных файлах /etc/hosts, находящихся на хостах медиа-сервера и web-конфигуратора (в случае, если DNS-сервер не используется).

   Пример для варианта с /etc/hosts:

   IP-REC1-STORAGE rec.media-storage.ecss
   IP-REC2-STORAGE rec.media-storage.ecss
   IP-FAX1-STORAGE fax.media-storage.ecss
   IP-FAX2-STORAGE fax.media-storage.ecss
   IP-VOICEMAIL1-STORAGE voicemail.media-storage.ecss
   IP-VOICEMAIL2-STORAGE voicemail.media-storage.ecss

   где:

   • IP-REC1-STORAGE — IP-адрес 1-го хоста для хранения записей разговоров;
   • IP-REC2-STORAGE — IP-адрес 2-го хоста для хранения записей разговоров;
   • IP-FAX1-STORAGE — IP-адрес 1-го хоста для хранения файлов принятых факсов;
   • IP-FAX2-STORAGE — IP-адрес 2-го хоста для хранения файлов принятых факсов;
   • IP-VOICEMAIL1-STORAGE — IP-адрес 1-го хоста для хранения записей voicemail;
   • IP-VOICEMAIL2-STORAGE — IP-адрес 2-го хоста для хранения записей voicemail.

2. Скорректируйте значение указателей ресурса URI для обращения к хранилищу.

   По умолчанию для данных параметров установлено значение system. В этом случае сетевой адрес хранилища для всех трех сервисов одинаков. Его значение устанавливается командами /system/system-restfs-host и /system/system-restfs-port.

   Для установки значения указателя ресурса URI для каждого из сервисов используется своя команда:

   /domain/DOMAIN_NAME/properties/set call_record_server_peer <URI>

   /domain/DOMAIN_NAME/properties/set fax_server_peer <URI>

   /domain/DOMAIN_NAME/properties/set voicemail_server_peer <URI>

   где:

   • URI — указатель ресурса хоста, который используется в качестве сетевого хранилища.

   Примеры команд для настройки сетевого хранилища на выделенном сервере с URI media-storage.ecss:

   /domain/DOMAIN_NAME/properties/set call_record_server_peer rec.media-storage.ecss:9990
   /domain/DOMAIN_NAME/properties/set fax_server_peer fax.media-storage.ecss:9990
   /domain/DOMAIN_NAME/properties/set voicemail_server_peer voicemail.media-storage.ecss:9990

   После выполнения настройки ресурса хоста все данные, формируемые сервисами, будут записываться на сервера, идентифицируемые теми URI, которые были указаны в командах настройки.

Переполнение разделов хранилища

Для предотвращения ситуаций переполнения разделов хранилища нужно настроить пороги генерации предупреждений и аварийных сообщений о переполнении раздела (см. Пороги использования ресурсов). При достижении настроенного порога система автоматически сообщит об этом.

Для предотвращения переполнения разделов хранилища на уровне каждого кластера RestFS есть подсистема, которая позволяет автоматически удалять файлы по определенным правилам — autocleaner. Сервис  autocleaner может быть сконфигурирован  командами функции autocleaner , либо будут использованы дефолтные установки.

Настойка глобально autocleaner, для кластера RestFS в целом

Функция предотвращения переполнения разделов хранилища реализована, как глобально для кластера RestFS в целом, так и для каждого отдельного домена ECSS. 
В случае отсутствия файла "cleaner.json" в директории /var/lib/ecss/restfs/domain/<Имя_домена>/ , т.е. в данном домене не созданы правила удаления старых файлов, будет применятся глобальная конфигурация (указанная в файле  /var/lib/ecss/restfs/cleaner.json, данный файл создается при установке RestFS).

параметр "path":"records" указывает путь поиска файлов относительно директории /var/lib/ecss/restfs/,
в данном примере  /var/lib/ecss/restfs/domain/test_domain/records и /var/lib/ecss/restfs/domain/trueconf.ru/records :

параметр  "file-mask": "*.wav"/ "*.mp3" указывает фильтр поиска файлов для проверки на старость :

параметр  "outdate":   "180" указывает как долго должны быть сохранены файлы с указанным критерием поиска (для примера *.mp3), в данном случае удалять все файлы старше 180 дней. 

Для примера если сегодня 07 августа, то при значении outdate=180 будут удалятся файлы созданные до 08 февраля этого года.
Файлы "ai_you_test.wav" и "2025-08-06_12-02-27_o_42009-42007.mp3" созданы 24 апреля и 06 августа соответственно, поэтому не будут удалены.

параметр  "exclude": ["system"] указывает директорию исключения. 

В данном примере файлы activated.wav / ai_activated.wav / ai_added.wav / ai_agent_already_on.wav / ai_you_have.wav — находятся в директории "system" — директории исключения, поэтому они никогда не будут удалены. Файл  ai_you_test.wav  будет удален 21 октября.

Дополнительно для кластера RestFS в целом, есть возможность указать директорию, которая так же будет анализироваться сервисом autocleaner. По умолчанию добавлена директория "/tmp" , при этом указывается полный путь , от "/" файловой системы.

параметр  "global-path": "/tmp" указывает глобальную директорию "/tmp" для сервиса autocleaner :

Для "global-path": можно указать только параметр "file-mask":

параметры "outdate": и "exclude": для "global-path": не применимы

Настойка  autocleaner, для определенного домена

При необходимости настроить для определенного домена индивидуальные параметры, для примера увеличить время хранения файлов с 180 до 365 дней, можно использовать cleaner.json для домена. При использовании данного файла, параметры из глобального файла /var/lib/ecss/restfs/cleaner.json анализироваться не будут.

Файл cleaner.json должен находится — /var/lib/ecss/restfs/domain/<имя_домена>/cleaner.json.

Данный файл можно сконфигурировать через CoCon:

/domain/имя_домена/restfs/autocleaner/ 

действия:

add-rule — добавить новое правило;
change-rule— изменить правило;     
info— посмотреть информацию , со списком всех правил;
remove-rule— удалить правило.

атрибуты:
rule position — позиция правила в списке правил;
mask — фильтр поиска файлов;
outdate — время хранения файлов до удаления в днях;
path — путь (относительно /var/lib/ecss/restfs/domain/имя_домена/) к директории  поиска файлов.

после выполнения команды : /domain/имя_домена/restfs/autocleaner/add-rule или /domain/имя_домена/restfs/autocleaner/change-rule в директории —
/var/lib/ecss/restfs/domain/имя_домена будет создан файл cleaner.json. И для данного домена autocleaner будет использовать локальную конфигурацию вместо глобальной.