документация

Информация, необходимая для эксплуатации

программного обеспечения

1. Персонал и режимы работы Эксплуатация Платформы голосовых роботов предполагает два основных
профиля пользователей:
1). Системный администратор — осуществляет техническое
обслуживание, мониторинг ресурсов, резервное копирование и
управление инфраструктурой (Docker, MongoDB, Kafka, FreeSWITCH).
2). Администратор сценариев (Оператор Voicebot) — использует веб-интерфейс "Voicebot" (Vue.js) для создания, настройки и контроля голосовых кампаний, анализа результатов звонков и просмотра статусов задач.
Платформа функционирует в непрерывном круглосуточном режиме (24/7/365).

1.2. Мониторинг работоспособности и сбор метрик
Контроль эксплуатационного состояния платформы осуществляется через интеграцию с системой Zabbix и Prometheus. Администратору необходимо контролировать следующие ключевые параметры:
- Доступность API-эндпоинтов микросервисов (Sip-system, Media-service, Tts-service, CTS) по протоколу HTTPS (код ответа 200 OK).
- Состояние портов телефонии: Проверка доступности SIP-порта FreeSWITCH (стандартно 5060/5080 UDP/TCP).
- Метрики очередей Kafka: Мониторинг lag (отставания) потребителей в топиках обработки задач, чтобы исключить задержки в обработке callTask.
- Наполнение СУБД: Мониторинг свободного места на VM с MongoDB (общий объем данных не должен превышать 40 ГБ без масштабирования дискового пространства).

1.3. Резервное копирование и восстановление данных
Для обеспечения отказоустойчивости (SLA 99,9%) настроено автоматическое ежедневное резервное копирование (в период минимальной нагрузки на систему).
1. Резервное копирование базы данных (выполняется через cron на VM с MongoDB):
mongodump --uri="mongodb://localhost:27017/voice_platform" --out=/var/backups/mongo/$(date +%F)
2. Резервное копирование медиафайлов и конфигураций FreeSWITCH:
tar -czf /var/backups/configs/freeswitch_cfg_$(date +%F).tar.gz /etc/freeswitch/
3. Восстановление системы в случае сбоя:
В случае падения инстанса администратор восстанавливает конфигурацию ОС, разворачивает контейнеры из GitLab CI/CD или через `docker-compose up -d`, после чего производит восстановление данных из последнего актуального бэкапа командой:
mongorestore --uri="mongodb://localhost:27017/voice_platform" /var/backups/mongo/[дата_бэкапа]/

1.4. Процедура устранения типовых неисправностей (Траблшутинг)
- Симптом: Задачи застревают в статусе DIALING или ONGOING, звонки не инициируются.
Решение: Проверить статус брокера сообщений Kafka и консюмера `callRequestConsumer`. При необходимости перезапустить службу Kafka или микросервис `Calling-system`.
- Симптом: Робот не реагирует на ответы пользователя (проблема с ASR).
Решение: Проверить логи компонента `Media-service`. Проверить доступность внешнего API (Yandex SpeechKit) и валидность API-ключей в конфигурационном файле.
- Симптом: Ошибка 503 (FatalErrorHangup) в логах сценария.
Решение: Проверить состояние акторов в `Sip-servlet` через логи приложения, убедиться, что FreeSWITCH корректно передает медиапоток и SIP-сигнализацию.