Диагностика и логи

Что такое сбор диагностической информации?

Как собрать диагностическую информацию?

1. В приложении перейдите в Настройки (аватар над списком чатов) > О программе и нажмите кнопку Начать сбор диагностических данных внизу экрана.
2. Воспроизведите проблему, чтобы она зафиксировалась в логах.
3. Вернитесь в раздел О программе и нажмите Остановить и поделиться.
   
   Начиная с версии 3.37 в десктоп-приложении также будет предложено сохранить логи обновления.
4. Передайте файл логов в поддержку.

Что такое инженерное меню?

Это специальный экран, содержащий дополнительную информацию о приложении, пользователе и текущей сессии, а также специальные служебные функции и дополнительные логи для диагностики.

Как открыть инженерное меню?

1. В приложении выберите Настройки (аватар над списком чатов) > О программе.
2. Несколько раз нажмите на логотип приложения, пока не откроется инженерное меню.

Инженерное меню в приложении для Android

Содержит следующие вкладки (указаны только наиболее полезные для поддержки):

Вкладка	Описание
USER	Main User info — данные о пользователе. Session info — информация о текущей сессии. Sync info — настройки, полученные с сервера. App info — сведения о приложении.
DATA	CLEAR DATABASE — очистка внутренней базы данных (без выхода из сессии). CLEAR FILES — удаление кэшированных файлов. Cache size — размер базы данных и кэша.
LOG	Main log — общие логи: Write main log to file — включение записи логов. SHARE MAIN LOG FILE — отправка файла логов. CLEAR MAIN LOG FILE — очистка файла логов. Call log — логи звонков и конференций: SHARE CALL LOG FILE — отправка файла логов. CLEAR CALL LOG FILE — очистка файла логов. Smart Apps log — логи Smart Apps (аналогично Main log).
FEATURES	Переключает дополнительные функции (Smart Apps, интеграция с Vinteo и др.).
PUSH	Информация о push-уведомлениях: push_service_type — текущая служба push-уведомлений. Если значение UNDEFINED, возможные причины: Отсутствие необходимых push-служб на устройстве. Нет разрешения на уведомления в настройках ОС. Некорректные настройки push-службы на сервере (см. подробнее). push_token — токен push-службы. Должен содержать звёздочки. Если видите прочерк — уведомления не работают. Нажмите RESET PUSH TOKEN, чтобы обновить токен. User Push Service — если уведомления не работают, в качестве крайней меры вы можете выбрать другую службу и нажать SET USER PUSH SERVICE. Если проблема не решается, соберите логи и обратитесь в поддержку eXpress.

Инженерное меню в приложении для iOS (iPadOS)

Содержит следующие разделы (указаны только ключевые для диагностики):

Раздел/пункт	Описание
Файловая запись логов	Включает запись общих логов в файл.
Инфо на экране звонка	Отображает технические данные во время звонка.
Логи уведомлений	Устаревший параметр (логирование push-уведомлений).
Smart Apps	Активация функции Smart Apps.
Собирать логи Smart App	Запись логов Smart Apps в общий лог.
Подробные ошибки Share	Устаревший параметр (логирование системной функции «поделиться»).
Current user info	Данные пользователя: HUID, страна, телефон. apnsPushToken, voexPushToken — токены для уведомлений и звонков (не должны быть пустыми). signKeyId — ID открытого ключа шифрования пользователя.
Список чатов	Сводная информация о чатах.
Логи	Общие логи приложения (кроме звонков и конференций). Подробнее.
VOEX сессии	Логи звонков и конференций.
LOG toggler	Устаревший параметр (дополнительная информация в логах).

Инженерное меню в приложении для Aurora

Содержит следующие вкладки:

Вкладка	Описание
USER	Информация о пользователе, сессии и настройках синхронизации.
DATA	CLEAR DATABASE — очистка базы данных. CLEAR FILES — удаление кэша файлов. Cache size — размер кэша.
LOG	управление логами (подробнее).

Инженерное меню в веб-/десктоп-приложении

В веб-/десктоп-приложении инженерное меню также можно открыть на экране входа, многократно нажав на логотип.

Содержит следующие вкладки (ключевые для диагностики):

Вкладка	Описание
Общее	Сохранять статистику — запись дополнительной статистики. Логировать все запросы в сокет — запись сетевых запросов (выводит больше подробностей в консоли разработчика). Собирать логи SmartApp — включение логов Smart Apps. Инфо для разработчика в меню сообщения — дополнительная информация о сообщениях и звонках через контекстное меню. Подробнее. СКАЧАТЬ СТЕЙТ — сохранение данных о пользователе и чатах. СБРОСИТЬ СТЕЙТ — перезагрузка данных без выхода из сессии. СКОПИРОВАТЬ СТЕЙТ В КОНСОЛЬ — вывод данных в консоль. СБРОСИТЬ СТАТИСТИКУ — очистка статистики. ОТКРЫТЬ КОНСОЛЬ — доступ к браузерной консоли. Данные о пользователе (HUID), сессии (UDID), статистика чатов.
Вебсокет	Статистика WebSocket.
Рест	Статистика REST.
Звонки	Логи звонков и конференций (доступно скачивание).
SmartApps	Отладка Smart Apps.
Experimental	Экспериментальные функции (Smart Apps, Vinteo и др.).

Кнопка в верхнем правом углу переключает компактный режим.

Зачем нужны эти логи?

Логи аутентификации из приложения на Android

Логи аутентификации из приложения на iOS

Логи аутентификации из приложения на Aurora

Эта функция пока недоступна в приложении для Aurora. Можно собрать только логи после входа в приложение из инженерного меню.

Логи аутентификации из веб-/десктоп-приложения

Отчёт об ошибке

Во всплывающем сообщении об ошибке щёлкните Подробнее. Раскройте блок data для просмотра причины ошибки в открывшемся окне.

Диагностика в консоли разработчика

Для сбора логов или диагностики сетевых запросов при проблемах на экране входа:

1. Откройте консоль браузера или десктоп-приложения:

   Платформа	Путь
   Chrome, Edge, Opera, Яндекс Браузер, десктоп-приложение	Нажмите F12 (или Fn + F12).
   Safari (macOS)	Включите меню «Разработка»: Safari > Настройки > Дополнения > включите Показывать функции для разработчиков. После этого: Разработка > Показать веб-инспектор.

2. Перейдите на вкладку Console.
3. Воспроизведите проблему при входе.
4. Найдите последнюю ошибку (красный текст) и нажмите на ссылку в ней.
5. Во вкладке Network выберите соответствующий запрос.
6. В описании ошибки откройте вкладку Response.
7. Значение Reason укажет причину ошибки. Можно скопировать его (сделать скриншот) и отправить в поддержку.

Серверные логи аутентификации

Попытки входа и причины ошибок доступны в панели администратора:

Дополнительные логи на мобильных устройствах

Android — из инженерного меню

1. Откройте Настройки (аватар над списком чатов) > О программе > многократно нажмите на логотип.
2. На вкладке LOG активируйте Write main log to file.
3. Воспроизведите проблему в основном интерфейсе.
4. Вернитесь в инженерное меню > LOG > SHARE MAIN LOG FILE.

iOS/iPadOS — из инженерного меню

Чтобы собрать имеющиеся общие логи из инженерного меню приложения на iOS/iPadOS «задним числом»:

1. Откройте инженерное меню: Настройки > О программе > многократно нажмите на логотип.
2. В папке Logs используйте кнопку «Поделиться» для выбора типа лога:

   Пункт	Описание
   Main app logs	Общие логи приложения при проблемах с его работой.
   Push extension logs	Логи уведомлений и счётчиков непрочитанных сообщений.
   Share extension logs	Логи системной функции «Поделиться» в iOS.

Aurora OS — из инженерного меню

1. Откройте инженерное меню: Настройки > О программе > многократно нажмите на логотип.
2. Включите Write main log to file на вкладке LOG.
3. Воспроизведите проблему в основном интерфейсе.
4. Вернитесь в инженерное меню > LOG > SHARE MAIN LOG FILE.

Сбор логов на десктопных платформах

Консоль разработчика (веб/десктоп)

Чтобы просмотреть логи из консоли, откройте веб- или десктоп-приложение, воспроизведите ошибку и затем:

1. Если необходимо (по просьбе поддержки), включите расширенное логирование запросов:
   • Откройте инженерное меню через Настройки > О программе > многократно нажмите на логотип.
   • Включите Логировать все запросы в сокет и обновите кэш Ctrl (Cmd) + R.
2. Откройте консоль разработчика:

   Платформа	Путь
   Chromium-браузеры и десктоп-приложение	Нажмите F12 (на Mac: Cmd+Opt+I или выберите Консоль в меню приложения).
   Safari	Меню Safari > Настройки > Дополнения > Показывать функции для разработчиков. Далее в меню выберите Разработка > Показать веб-инспектор.

3. В настройках (кнопка-шестерёнка в верхнем углу консоли) включите Отображать временные метки (Show timestamps)
4. Очистите консоль (Clear console) > воспроизведите ошибку
5. Сохраните логи через Сохранить как (Save as...) или сделайте скриншот.

Сетевые запросы (HAR) (веб/десктоп)

1. Откройте консоль разработчика:

   Платформа	Путь
   Chromium-браузеры и десктоп-приложение	Нажмите F12 (на Mac: Cmd+Opt+I или выберите Консоль в меню приложения).
   Safari	Меню Safari > Настройки > Дополнения > Показывать функции для разработчиков. Далее в меню выберите Разработка > Показать веб-инспектор.

2. Откройте вкладку Network.
3. Очистите список запросов (Clear) > обновите страницу Ctrl/Cmd+R и воспроизведите ошибку.
4. Экспортируйте логи через Сохранить все как HAR с содержимым (Save all as HAR with content) в Chromium или кнопка Экспортировать в Safari

Стейт веб-/десктоп-приложения

Стейт (англ. state — состояние) — это сводная информация о текущем пользователе, сервере, приложении, ключах и событиях. Для анализа проблем может изредка потребоваться вместе с логами. Входит в состав диагностической информации, собранной на экране О программе.

1. Откройте инженерное меню: Настройки > О программе > многократно нажмите на логотип.
2. На вкладке Общее используйте:

   Кнопка	Действие
   СКАЧАТЬ СТЕЙТ	Сохраняет стейт в файл.
   СКОПИРОВАТЬ СТЕЙТ В КОНСОЛЬ	Выводит стейт в консоль разработчика.

Информация для разработчика о сообщениях и звонках (веб и десктоп)

1. Откройте инженерное меню: Настройки > О программе > многократно нажмите на логотип.
2. Включите Инфо для разработчика в меню сообщения.
3. Щёлкните правой кнопкой мыши любое сообщение или звонок в списке звонков и выберите Инфо для разработчика.

Логи работы и обновления десктоп-приложения

Содержит события, связанные с запуском, работой и обновлением приложения.

Логи запуска десктоп-приложения

Для анализа проблем с запуском десктоп-приложения (белый экран, зависания) и взаимодействия с операционной системой:

1. Закройте приложение.
2. Выполните следующие шаги:
   
   Если используется брендированное ETS-приложение, вместо eXpress будет другое название.
   
   

   ОС	Шаги
   Windows	1. Откройте командную строку: Win+R > введите cmd > Enter. 2. Щёлкните ярлык приложения правой кнопкой мыши > Свойства > скопируйте путь к файлу .exe из поля Объект. 3. В командную строку введите "скопированный_путь_к_eXpress.exe" --args --enable-logging --log-level=DEBUG (⚠️ путь должен быть в двойных кавычках, если содержит пробелы) и нажмите Enter.
   macOS	1. Откройте приложение «Терминал». 2. Введите cd /Applications и нажмите Enter. 3. В терминал введите: open eXpress.app --args --enable-logging --log-level=DEBUG и нажмите Enter. 4. Выведите лог в терминал: log stream --predicate 'process == "eXpress"' --style compact и нажмите Enter.
   Linux	1. Откройте приложение терминала. 2. Щёлкните ярлык приложения правой кнопкой мыши > Свойства > скопируйте путь к нему (например, из поля Команда на Astra Linux). Либо скопируйте путь к директории с приложением, а имя исполняемого файла допишите в конце пути. 3. В терминал введите: "путь_к_приложению" --args --enable-logging --log-level=DEBUG (⚠️ путь должен быть в двойных кавычках, если содержит пробелы) и нажмите Enter.

3. Воспроизведите проблему с приложением.
4. Отправьте скриншот или листинг терминала/командной строки в поддержку.

Логи звонков и конференций на Android

Логи сохраняются на вкладке LOG > Call log инженерного меню:

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Нажмите SHARE CALL LOG FILE для сохранения или отправки лога.

❓Связанные вопросы:
• Инженерное меню приложения

Логи звонков и конференций на iOS/iPadOS

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Выберите папку:

   Папка	Содержимое
   Voex сессии	Логи звонков/конференций
   Список чатов	Стейт чатов

3. Используйте кнопку «Поделиться» для экспорта

❓Связанные вопросы:
• Инженерное меню приложения

Логи звонков и конференций в веб-/десктоп-приложении

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. На вкладке Звонки найдите нужный лог (содержит ID звонка)
3. Скачайте лог соответствующей кнопкой

❓Связанные вопросы:
• Инженерное меню приложения

Уведомление «Оцените качество звонка»

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

При оценке меньше 5 (или нажатии Нет в уведомлении «Довольны ли вы качеством звонка?»):

• Клиентские логи автоматически выгружаются на сервер
  RTS
  /
  CTS
  /
  eCTS
  , где их может просмотреть администратор или поддержка.
• Они доступны администратору в папке client logs архива с логами.

❓Связанные вопросы:
• Оценки звонков

Серверные логи звонков и конференций

Серверные логи обычных звонков и конференций eXpress

1. В панели администратора: Звонки/Конференции > найдите по ID чата/звонка > Скачать логи. ID можно получить из лога звонка в инженерном меню приложения.
2. Для уточнения версии Janus:

   Версия сервера	Шаги
   3.60 и выше	См. версию Janus в разделе «Сервер» в панели администратора.
   Ниже 3.60	Выполните docker ps -a на сервере VoEx/Front.

Серверные логи SIP-звонков

Соберите логи сервиса messaging на корпоративном сервере (подробнее).

❓Связанные вопросы:
• Управление звонками
• Управление конференциями

Клиентские логи SmartApps

Сбор клиентских логов SmartApps через экран «О программе»

Логи для диагностики SmartApps есть в диагностической информации.

Сбор клиентских логов закреплённых SmartApps на Android/iOS

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Включите сбор логов SmartApps:
   • Android: LOG > SmartApps log > Write main log to file.
   • iOS/iPadOS и веб/десктоп: включите Собирать логи SmartApp (Collect Smart apps logs).
3. Долго нажмите на закреплённый внизу SmartApp > Собрать логи.

Логи SmartApps на Android

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Вкладка LOG > SmartApps log > включите Write main log to file.
   Для очистки логов: выключите и снова включите тумблер.
3. Через кнопку-троеточие в SmartApp скачайте логи.

При проблемах на этапе запуска SmartApp:

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Вкладка LOG > SmartApps log > включите Write main log to file.
3. О программе > Начать сбор диагностических данных.
4. Откройте проблемный SmartApp > подождите 15 секунд.
5. О программе > Остановить и поделиться.

Логи SmartApps на iOS/iPadOS

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Включите Собирать логи SmartApp
   Для очистки логов: выключите и снова включите тумблер.
3. Через кнопку-троеточие в SmartApp скачайте логи.

Логи SmartApps в веб-/десктоп-приложении

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Включите Собирать логи SmartApp
   Для предварительной очистки: Ctrl+R (Mac: Cmd+R)
3. Если нужен режим отладки (необязательно): на вкладке SmartApps в инженерном меню включите Включить режим отладки SmartApps, укажите HUID бота SmartApp в соответствующее поле и нажмите кнопку Установить параметры отладки.
4. Воспроизведите проблему и через кнопку-троеточие в SmartApp скачайте логи.

Клиентские логи SmartApps «Главная» и «Сервисы»

1. Откройте инженерное меню: Настройки (аватар) > О программе > многократно нажмите на логотип.
2. Включите сбор логов SmartApps:

   Платформа	Путь
   Android	LOG > SmartApps log > Write main log to file.
   iOS/iPadOS и веб/десктоп	Включите Собирать логи SmartApp (Collect Smart apps logs).

3. Соберите лог из SmartApp одним из способов:
   • Через кнопку-троеточие в SmartApp.
   • Долго нажмите на Главная или Сервисы > Собрать логи (мобильное приложение).
   • Откройте Сервисы (9 точек) > многократно нажмите на надпись Сервисы > в системном меню выберите Home Screen > три точки > Логи.

Серверные логи ботов и SmartApps

Серверные логи ботов и SmartApps

1. Подключитесь к серверу: ssh user@your.server
2. Определите имя контейнера с ботом/SmartApp (последний столбец): docker ps
   Некоторые SmartApps могут иметь два контейнера (основной и worker). В таком случае потребуются логи обоих этих контейнеров SmartApp.
3. Экспортируйте логи: docker logs CONTAINER_NAME > /tmp/bot_logs.txt 2>&1
4. Скачайте файл: scp user@your.server:/tmp/bot_logs.txt

Файл конфигурации .env

Расположение: /opt/express/bots/your_bot/.env

Содержит переменные бота/SmartApp, также в нём можно указать настройки отладки (например, DEBUG=true). Подробности см. в комментариях внутри файла.

❓Связанные вопросы:
• Серверные логи аутентификации
• Серверные логи звонков и конференций
• Серверные логи ботов и Smart Apps

Уровни логирования

Есть следующие уровни логирования серверных сервисов:

Как задать уровень логирования

Пример для сервиса интеграции с Active Directory (установка уровня debug):

Ожидаемый ответ: ok.

Постоянное изменение уровня логирования

Логи Docker-контейнеров корпоративного сервера

Чтобы собрать логи через панель администратора:

1. Перейдите в раздел Контейнеры.
2. Нажмите >_логи у нужного контейнера.
3. Укажите дату и количество строк, снимите флажок follow (чтобы не получать сообщения в режиме реального времени) и нажмите show.

При переполнении буфера обмена старые логи перезаписываются. Логи очищаются при обновлении контейнера.

Сбор логов через консоль

Ключ tail выполняет вывод последних строк:

Примеры для других сервисов:

Ключи since и until выводят логи за период:

Подробнее: документация Docker.

Логи контейнеров в подах Kubernetes

Базовая информация: Kubernetes. Подробнее: kubectl logs.

1. Получите список подов: kubectl get pods -n <namespace>

   Если подов с искомым контейнером несколько, следующие команды придётся выполнить для каждого из них.

2. Включите режим INFO для контейнера внутри пода: kubectl -n <namespace> exec -ti <pod_id> -- bin/<service_name> rpc "Logger.configure(level: :info)"
3. Воспроизведите проблему.
4. Соберите логи: kubectl logs --tail=2000 -n <namespace> <pod_id> > pod_id.log
5. Верните режим ERROR: kubectl -n <namespace> exec -ti <pod_id> -- bin/<service_name> rpc "Logger.configure(level: :error)"
6. Передайте логи технической поддержке eXpress.

Диагностика сертификатов SSL

Способы проверки:

Версия MS Outlook

Чтобы просмотреть версию настольного приложения Outlook:

Версия надстройки

Чтобы просмотреть номер версии надстройки:

Логи надстройки для Windows

Локальный лог надстройки, установленной через пакет MSI, находится здесь: C:\Logs\ExpressMeetingAddIn<дата>.log.

Уровень логирования настраивается в файле serilogSettings.json в папке установки надстройки. Если нужен полный подробный лог для отладки, задайте значение Verbose атрибутам MinimumLevel.Default и MinimumLevel.Override.Default в файле (не рекомендуется для постоянного использования: сильно увеличивает размер лога и может замедлить работу).

Также потребуется файл конфигурации ExpressMeeting.dll.config из папки установки надстройки (например, C:\Program Files\eXpress\ExpressMeeting).

Если используется брендированное приложение, вместо Express может быть другое название.

❓ Связанные вопросы:
• Логи установки MSI на Windows

Логи надстройки для Outlook Web Access (macOS)

Клиентские логи надстройки для OWA отсутствуют. Для диагностики используются серверные логи.

Серверные логи надстройки Outlook

Логи серверной части надстройки, использующей аутентификацию AD, по умолчанию хранятся в следующей папке сервера:

Путь к папке указывается в конфигурационном файле appsettings.Production.json в ключе:

См. руководство по установке надстройки для администратора.

Чтобы собрать лог серверной части надстройки с аутентификацией Keycloak, выполните следующие команды:

Файлы с информацией о системе или процессе установки помогают сузить круг возможных причин технических неполадок. Собранную информацию о системе вы можете передать в поддержку eXpress.

Сведения о системе MSInfo (Windows)

1. Нажмите сочетание клавиш Windows + R.
2. В окне «Выполнить» введите MSInfo32 и нажмите Enter.
3. В окне «Информация о системе» нажмите на Сведения о системе, откройте меню Файл и выберите Экспорт.
4. В появившемся окне «Экспортировать как» выберите Рабочий стол.
5. Назовите файл MSInfo и нажмите Сохранить.

Чтобы уменьшить размер файла:

1. Откройте сохранённый файл MSInfo в блокноте.
2. Нажмите Ctrl + F и найдите [Windows Error Reporting] (Отчеты об ошибках Windows).
3. Удалите весь текст, который идёт после первых десяти строк раздела [Windows Error Reporting].
4. Сохраните файл.

Средство диагностики DirectX (Windows)

1. Нажмите сочетание клавиш Windows + R.
2. В окне «Выполнить» введите dxdiag и нажмите Enter.
3. В окне «Средство диагностики DirectX» нажмите Сохранить все сведения.
4. Назовите файл dxdiag и нажмите Сохранить.

Отчёт о системе (macOS)

1. Откройте меню Apple и выберите Об этом Mac.
2. Нажмите кнопку Отчет о системе или нажмите Подробнее и в окне настроек выберите Отчет о системе.
3. Выберите Файл > Сохранить и сохраните файл на рабочий стол.

Информация о системе Linux (утилита inxi)

1. Откройте терминал.
2. Установите утилиту inxi командой sudo apt install inxi или sudo yum install inxi.
3. Выполните команду inxi -Fxz.
4. Сохраните вывод терминала в файл.

Логи установки пакета MSI на Windows

Чтобы собрать диагностику для процесса установки через установщик Windows, используйте следующую командную строку:

Здесь installer.msi — путь к пакету MSI, log.log — путь создаваемого файла лога.