Инженерное меню и логи

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

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

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

Инженерное меню в eXpress для 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 App в файл общих логов (Enable Smart Apps log).
• FEATURES. На этой вкладке переключаются дополнительные и экспериментальные функции eXpress: приложения Smart App (Smart Apps), интеграция с Vinteo и т.д.
• PUSH. В подразделе Push Services находятся сведения о службах push-уведомлений.

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

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

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

Инженерное меню в eXpress для ПК (веб/десктоп)

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

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


В веб- и десктоп-версиях eXpress в инженерном меню содержатся только логи звонков/конференций и стейт, а общие логи содержатся в браузерной консоли:
• Веб-версия: нажмите клавишу (Fn +) F12, на открывшейся сбоку панели выберите вкладку Console; для просмотра сетевых запросов выберите вкладку Network.
• Десктоп-версия: откройте инженерное меню через Настройки > О программе > много раз нажмите на логотип, пока не откроется меню > нажмите кнопку ОТКРЫТЬ КОНСОЛЬ.

Упрощённый сбор диагностических данных

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

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

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

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

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

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

Логи по звонкам и конференциям сохраняются на вкладке LOG инженерного меню в подразделе Call log. Чтобы получить и сохранить или отправить логи звонков или конференций:

1. Откройте инженерное меню: (Чаты >) Настройки > О программе > много раз нажмите на логотип, пока не откроется инженерное меню.
2. На вкладке LOG нажмите на кнопку SHARE CALL LOG FILE. Получившийся файл лога можно сохранить на устройстве или отправить.

Упрощённый сбор диагностических данных

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

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

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

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

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

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

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

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

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

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

Упрощённый сбор диагностических данных

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

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

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

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

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

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

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

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

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

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

Лог звонка или конференции из инженерного меню (веб)

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

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

Лога звонка или конференции через уведомление «Довольны ли Вы качеством звонка?» (веб)

Если настроено, по окончании звонка или конференции отображается всплывающее уведомление с просьбой оценить качество звонка. Если в ответ на вопрос «Довольны ли Вы качеством звонка?» выбрать НЕТ, лог звонка/конференции из клиентского приложения выгрузится на сервер, откуда его вместе с серверными логами звонка/конференции может скачать системный администратор. В скачанном архиве клиентские логи находятся в подпапке client logs.

Упрощённый сбор диагностических данных

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

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

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

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

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

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

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

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

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

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

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

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

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

Лога звонка или конференции через уведомление «Довольны ли Вы качеством звонка?» (десктоп)

Если настроено, по окончании звонка или конференции отображается всплывающее уведомление с просьбой оценить качество звонка. Если в ответ на вопрос «Довольны ли Вы качеством звонка?» выбрать НЕТ, лог звонка/конференции из клиентского приложения выгрузится на сервер, откуда его вместе с серверными логами звонка/конференции может скачать системный администратор. В скачанном архиве клиентские логи находятся в подпапке client logs.

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

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

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

Логи регистрации или авторизации из приложения на Android

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

Логи регистрации или авторизации из приложения на iOS

1. На всплывающей ошибке нажмите кнопку Показать отчет.
2. Наверху справа нажмите кнопку «поделиться», чтобы сохранить или отправить логи в поддержку.

Логи регистрации или авторизации из веб-приложения

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

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

1. Нажмите Войти с помощью номера телефона внизу страницы.
2. Много раз нажмите на логотип, пока не откроется инженерное меню. Далее нажмите кнопку ОТКРЫТЬ КОНСОЛЬ.
3. В открывшейся справа консоли выберите вкладку Console. Для просмотра сетевых запросов выберите вкладку Network.
4. В консоли нажмите кнопку-шестерёнку наверху, чтобы открыть настройки, и в подразделе Console включите параметр Show timestamps. Таким образом, в консоли будет фиксироваться время событий.
5. Можно предварительно очистить консоль, в контекстном меню выбрав команду Clear console. Воспроизведите проблему с авторизацией. В консоли появится ошибка или предупреждение. Сделайте скриншот ошибки или сохраните весь лог консоли командой Save as... в контекстном меню лога консоли.
6. Чтобы сохранить информацию о сетевых запросах в файл 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
Либо уровень логирования задаётся командой в консоли самого сервиса, без повторного deploy контейнера:
Logger.configure(level: :debug)

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

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


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

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

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

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

Логи контейнеров 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. В инженерном меню приложения ((Чаты >) Настройки > О программе > много раз нажмите на логотип, пока не откроется инженерное меню и далее:
   • Android: на вкладке LOG в подразделе Smart Apps log включите Enable Smart Apps log.
   • iOS и веб/десктоп: включите настройку Собирать логи SmartApp (Collect Smart apps logs).
2. Закройте инженерное меню, откройте Smart App, воспроизведите проблему и через кнопку-троеточие в самом Smart App скачайте его логи.

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

1. В инженерном меню приложения ((Чаты >) Настройки > О программе > много раз нажмите на логотип, пока не откроется инженерное меню и далее:
   • Android: на вкладке LOG в подразделе Smart Apps log включите Enable Smart Apps log.
   • iOS и веб/десктоп: включите настройку Собирать логи SmartApp (Collect Smart apps logs).
2. Закройте инженерное меню, и:
   • откройте проблемный Smart App, воспроизведите проблему и через кнопку-троеточие скачайте логи в самом Smart App.
   • либо откройте Сервисы (кнопка с 9-ю точками) > после загрузки много раз нажмите надпись Сервисы, пока не появится системное меню приложений. В нём выберите Home Screen. Нажмите три точки справа в верхнем углу и выберите Логи.

Серверные логи бота или 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