Справочный центр eXpress

Во всех клиентских версиях приложения для всех платформ есть инженерное меню, в котором находится дополнительная информация о приложении, пользователе, текущей сессии и логи. Через это меню можно собрать дополнительные логи с технической информацией и внутренними событиями приложения, его функций (Smart App) и сервера, которые помогут выявить причину возникшей проблемы.

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

Чтобы открыть инженерное меню, в eXpress нажмите Настройки (кнопка с шестерёнкой), выберите пункт О программе. Далее 11 раз нажмите на логотип приложения.

Общие логи из приложения для Android

Чтобы собрать общие логи из приложения на Android:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. На первой вкладке MAIN инженерного меню нажмите кнопку START DEBUG. Начнётся запись логов.
3. Выйдите из инженерного меню и воспроизведите проблему, которую нужно отразить в логах.
4. Вернитесь в инженерное меню и нажмите STOP DEBUG. Получившийся файл лога можно сохранить на устройстве или отправить кнопкой SHARE DEBUG LOG.

Логи звонков, конференций и сообщений из приложения для Android

Логи по звонкам и конференциям сохраняются на вкладке VOEX инженерного меню. Стейт (сводная информация) сообщений есть во вкладках CHATS и EVENTS. Чтобы получить и сохранить или отправить логи звонков, конференций или сообщений:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. Откройте соответствующую вкладку в инженерном меню.
3. Далее нажмите на значок печати в правом верхнем углу, в появившемся контекстном меню внизу нажмите ОК и выберите приложение или чат для отправки логов.

Общие логи из приложения для iOS / iPadOS

Если проблема воспроизвелась однократно и более не повторяется:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. В инженерном меню откройте папку Logs, нажмите кнопку Поделиться справа вверху.
3. Далее выберите, какие логи нужны:
   • Main app logs. Логи из основного приложения, которые нужны, если проблема возникла с приложением.
   • Push extension logs. Логи уведомлений, которые нужны при проблемах с уведомлениями или счётчиками непрочитанных сообщений.
   • Share extension logs. Логи, собираемые при отправке каких-либо данных из/в приложение через функцию shareTo («Поделиться»), которые нужны при проблемах с этой функцией.
4. Сохраните выбранные логи в файл или отправьте в поддержку.

Если проблема постоянная (в самом приложении), можно включить расширенное логирование заранее:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. В нижней части инженерного меню откройте Log Toggler. Включите тумблер Toggle all, чтобы в логи записывалась вся расширенная информация.
3. Далее перейдите в раздел Logs, нажмите значок урны, чтобы очистить старые логи.
4. Воспроизведите проблему, перейдите в инженерное меню, откройте папку Logs, нажмите кнопку Поделиться справа вверху. Сохраните Main app logs в файл или отправьте в поддержку.
5. В конце расширенное логирование можно выключить.

Логи звонков и сообщений из приложения для iOS / iPadOS

Логи звонков находятся в разделе Voex сессии инженерного меню. Стейт (сводная информация) чатов есть в разделе Список чатов. Чтобы собрать такие логи:

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

Общие логи из консоли веб-версии приложения

Чтобы получить логи и/или информацию о сетевых запросах:

1. Нажмите клавишу (Fn +) F12 и выберите вкладку Console. Для просмотра сетевых запросов выберите вкладку Network.
2. Можно предварительно очистить консоль, в контекстном меню выбрав команду Clear console. Воспроизведите проблему. В консоли появится ошибка или предупреждение. Сделайте скриншот ошибки или сохраните весь лог консоли командой Save as... в контекстном меню лога консоли.
3. Чтобы сохранить информацию о сетевых запросах в файл HAR, на вкладке Network в контекстном меню выберите команду Save all as HAR with content. Если нужно, сетевые запросы можно предварительно очистить кнопкой Clear наверху.

Если нужно, чтобы в логах консоли была расширенная информация, в eXpress откройте (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип > включите тумблер Логировать все запросы в сокет. После включения этой настройки понадобится перезагрузить страницу приложения (лучше с очисткой кэша нажатием клавиш Ctrl (Cmd) + R).

Стейт из инженерного меню веб-версии приложения

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

Чтобы скачать стейт или скопировать его в консоль:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. В инженерном меню на вкладке Общее нажмите СКАЧАТЬ СТЕЙТ, чтобы скачать стейт в виде файла, или СКОПИРОВАТЬ СТЕЙТ В КОНСОЛЬ, чтобы отобразить стейт в консоли.

Лог звонка или конференции из инженерного меню веб-версии приложения

Чтобы сохранить лог звонка или конференции из инженерного меню:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. Найдите нужный лог на вкладке Звонки.
   
   В названии звонка будет ID звонка/конференции, эта информация может пригодиться для поиска соответствующих логов на сервере.
3. Нажмите звонок/конференцию и нажмите кнопку для скачивания лога.

Общие логи из консоли десктоп-версии приложения

Чтобы получить логи и/или информацию о сетевых запросах:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип. Нажмите кнопку Открыть консоль. Откроется вкладка Console консоли. Для просмотра сетевых запросов выберите вкладку Network.
2. Можно предварительно очистить консоль, в контекстном меню выбрав команду Clear console. Воспроизведите проблему. В консоли появится ошибка или предупреждение. Сделайте скриншот ошибки или сохраните весь лог консоли командой Save as... в контекстном меню лога консоли.
3. Чтобы сохранить информацию о сетевых запросах в файл HAR, на вкладке Network в контекстном меню выберите команду Save all as HAR with content. Если нужно, сетевые запросы можно предварительно очистить кнопкой Clear наверху.

Если нужно, чтобы в логах консоли была расширенная информация, в eXpress откройте (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип > включите тумблер Логировать все запросы в сокет. После включения этой настройки понадобится перезагрузить страницу приложения (лучше с очисткой кэша нажатием клавиш Ctrl (Cmd) + R).

Стейт из инженерного меню десктоп-версии приложения

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

Чтобы скачать стейт или скопировать его в консоль:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. В инженерном меню на вкладке Общее нажмите СКАЧАТЬ СТЕЙТ, чтобы скачать стейт в виде файла, или СКОПИРОВАТЬ СТЕЙТ В КОНСОЛЬ, чтобы отобразить стейт в консоли.

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

Чтобы сохранить лог звонка или конференции из инженерного меню:

1. Откройте инженерное меню: (Главная > профиль >) Настройки > О программе > 11 раз нажмите на логотип.
2. Найдите нужный лог на вкладке Звонки.
   
   В названии звонка будет ID звонка/конференции, эта информация может пригодиться для поиска соответствующих логов на сервере.
3. Нажмите звонок/конференцию и нажмите кнопку для скачивания лога.

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

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

Версия	Расположение файла
Windows	%USERPROFILE%\AppData\Roaming\Express\log.log
Mac OS	Библиотека/Logs/Express
Linux	~/.config/eXpress/logs/log.log

Клиентские логи регистрации или авторизации

Собрать клиентские логи ошибок, возникающих на этапе регистрации или авторизации, возможно только в версии приложения для Android и в консоли веб-версии. На iOS есть подробная ошибка (открывается по кнопке Просмотреть отчет). В десктоп-версии возможности открыть консоль на этапе регистрации и авторизации пока нет (но это можно сделать в инженерном меню, если ошибка наблюдается при входе на корпоративный сервер через Настройки > Профиль).

Чтобы записать логи с экранов регистрации или авторизации на Android:

1. Вернитесь в начало на экран ввода номера телефона (если нужно, завершите сессию в настройках приложения для этого).
2. 11 раз нажмите надпись Введите номер телефона. Внизу всплывёт уведомление о ведущейся записи логов, в шторке уведомлений Android появится уведомление о записи логов «Идёт дебаг, не забудьте выключить».
3. Воспроизведите проблему, которая возникает на экране авторизации или сразу после входа.
4. Откройте шторку уведомлений Android, нажмите на уведомление «Идёт дебаг, не забудьте выключить», нажмите кнопку Остановить, затем Поделиться, чтобы сохранить или отправить логи в поддержку.

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

1. Нажмите клавишу (Fn +) F12 и выберите вкладку Console. Для просмотра сетевых запросов выберите вкладку Network.
2. Можно предварительно очистить консоль, в контекстном меню выбрав команду Clear console. Воспроизведите проблему с авторизацией. В консоли появится ошибка или предупреждение. Сделайте скриншот ошибки или сохраните весь лог консоли командой Save as... в контекстном меню лога консоли.
3. Чтобы сохранить информацию о сетевых запросах в файл HAR, на вкладке Network в контекстном меню выберите команду Save all as HAR with content. Если нужно, сетевые запросы можно предварительно очистить кнопкой Clear наверху.

Серверные логи регистрации или авторизации

Информация для системного администратора или поддержки

Попытки войти и причины неудачных попыток пользователей можно просмотреть в панели администратора корпоративного сервера в разделе Аудит.

Также в разделе Контейнеры в панели администратора можно получить логи следующих контейнеров:

• ad_integration — для диагностики интеграции с Active Directory;
• authentification — для диагностики входа в систему (только на ETS/RTS);
• email_notifications — если не приходит код на почту пользователя.

И на корпоративном сервере в разделе Настройки > E-mail есть функция Тестирование отправки e-mail для отправки пробных писем на любую электронную почту.

Информация для системного администратора или поддержки

Об уровнях логирования

Уровней логирования в контейнерах корпоративного сервера четыре:

1.     1. error выводит в логи только ошибки; рекомендуется для систем, где больше 10 тыс. пользователей.
2.     2. warning рекомендуется для постоянной работы.
3.     3. info используется по умолчанию, предназначен для диагностики проблем.
4.     4. debug - самый подробный для расширенной диагностики проблем. Не рекомендуется использовать, поскольку вызывает зависание системы.

Уровень логирования контейнеров задается командой, требующей повторный deploy контейнера командой dpl -d (ниже пример для контейнера trusts): trusts_env_override: LOGGER_LEVEL: debug

Учтите, что при выполнении команды dpl -d для критических контейнеров будет перерыв в работе сервиса!

Либо уровень логирования задаётся командой в консоли самого сервиса, без повторного deploy контейнера:
Logger.configure(level: :debug)

Логи звонков с корпоративного сервера

Чтобы собрать логи звонка с корпоративного сервера, в панели администратора перейдите в раздел Звонки, найдите желаемый звонок и нажмите Скачать логи.

Звонок можно найти по ID чата, в котором был звонок, либо по ID звонка (этот ID можно получить из логов инженерного меню приложения).

Логи конференций с корпоративного сервера

Начиная с версии бэкенда 2.12 логи конференций доступны в разделе Конференции панели администратора. Учтите, что конференция появится в этом списке, только если она была создана на этом сервере.

Для сбора логов конференции через консоль необходимо скачать файл лога из контейнера messaging (расположенный по пути app/var/log/voex_calls/call_id) через консоль: docker cp cts_messaging_1:/app/var/log/voex_calls/ИД_конференции/tmp/

ID конференции можно взять из логов звонков и конференций в инженерном меню самого приложения.

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

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

Общие логи сервера и логи контейнеров можно получить не только в панели администратора, но и через консоль:
dpl –-dc logs –tail=1000 > logs.txt

В tail указывается количество выводимых последних строк лога.

Логи контейнеров messaging и voex (для звонков): cd /opt/express dpl --dc logs -tail=1000 messaging > filename.log dpl --dc logs -tail=1000 voex > filename.log
Логи контейнеров coturn и redis (для звонков):
cd /opt/express-voice dpl --dc logs -tail=1000 coturn > filename.log dpl --dc logs -tail=1000 redis > filename.log
Логи контейнера file service:
cd /opt/express dpl --dc logs -tail=1000 file_service > filename.log

Клиентские логи Smart App

Как получить логи Smart App из клиентского приложения:

1. В инженерном меню приложения ((Главная > профиль >) Настройки > О программе > 11 нажатий на логотип) включите настройку Собирать логи SmartApp (Collect Smart apps logs).
2. При необходимости предварительно очистите логи Smart App:
   • Android и iOS: в инженерном меню выключите настройку Собирать логи SmartApp (Collect Smart apps logs), если она была включена, затем снова включите.
   • Веб/десктоп: для очистки логов закройте панель Smart App или очистите кэш приложения нажатием клавиш (Cmd) Ctrl + R.
3. Откройте Smart App, воспроизведите проблему и через кнопку-троеточие скачайте логи.

Серверные логи бота или Smart App

Информация для системного администратора или поддержки

Как получить логи бота и Smart App через консоль:

1. Зайдите на сервер, на котором запущен бот, используя ssh:
   ssh user@your.server
Найдите имя контейнера с ботом (в последнем столбце), используя команду:
docker ps Подставьте имя контейнера в следующую команду, чтобы записать логи бота в файл:
docker logs CONTAINER_NAME > /tmp/bot_logs.txt 2>&1 Выгрузите файл с логами с сервера, используя команду scp (команду запускать на ПК, не на сервере) или любым другим удобным для вас способом:
scp user@your.server:/tmp/bot_logs.txt