Диагностическая информация

Если в приложении возникла проблема или неполадка и вы не можете решить её самостоятельно, соберите информацию перед тем, как обратиться в поддержку:

• Сообщите, когда, где и у кого возникает неполадка;
• Подробно опишите шаги, приводящие к возникновению проблемы;
• Укажите модель устройства, версию операционной системы, версию приложения (см. ниже);
• Сделайте скриншоты или запишите видео неполадки. Если проблема в чате, дополнительно сделайте скриншот роутинга в свойствах чата. Если проблема связана с какими-либо настройками устройства, сделайте их скриншоты (не работают уведомления — скриншот настроек уведомлений устройства, не работает микрофон — скриншот разрешений на использование микрофона и т.д.).

При необходимости поддержка попросит дополнительную техническую информацию:

• Логи приложения с устройства, на котором наблюдалась проблема. См. «Упрощённый сбор диагностических данных», а также инструкции этого раздела ниже;
• Адрес корпоративного сервера, на котором вы зарегистрированы (чтобы увидеть его, в приложении откройте Настройки (аватар над списком чатов) > Профиль), либо в приложении откройте «Роутинг» в свойствах чата;
• HUID вашего аккаунта — его может увидеть администратор или поддержка в панели администратора, также он присутствует в ссылке на профиль и в инженерном меню приложения.

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

Версия веб-приложения: номер версии отображается в нижнем левом углу страницы. Веб-приложение обновляется по нажатию кнопки Обновить во всплывающем окне.

Версия десктоп-приложения: номер версии отображается в нижнем левом углу окна приложения. Вы либо самостоятельно устанавливаете обновления, которые приложение ищет автоматически (должен быть включён параметр Настройки (аватар над списком чатов) > Основные > Автоматически обновлять приложение), либо обновления устанавливаются системными администраторами организации.

Версия приложения для iOS/iPadOS

В мобильном приложении откройте Настройки (аватар над списком чатов) > О программе. Обычно обновления устанавливаются автоматически, если вы не выключили автоматические обновления приложений в App Store. Чтобы проверить наличие обновлений, откройте страницу приложения в App Store и нажмите кнопку Обновить. Информация о новой версии находится в разделе «Что нового» на странице приложения в магазине.

Версия приложения для Android

В мобильном приложении откройте Настройки (аватар над списком чатов) > О программе. Обычно обновления устанавливаются автоматически, если вы не выключили автоматические обновления приложений в магазине приложений. Чтобы проверить наличие обновлений, откройте страницу приложения в Google Play, Huawei App Gallery или RuStore и нажмите кнопку Обновить. Информация о новой версии находится в разделе «Что нового» на странице приложения в магазине.

Версия серверного ПО

Просмотреть версии сервисов серверного ПО eXpress может системный администратор, специалист технический поддержки или внедрения eXpress через панель администратора в разделах Контейнеры и/или Сервер > Версии сервисов.

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

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

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

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

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

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

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

• USER. Здесь находятся следующие сведения: о вошедшем в приложение пользователе (Main User info), о текущей сессии (Session info), о получаемых с сервера настройках (Sync info), сведения о приложении (App info).
• DATA. На этой вкладке есть: кнопка CLEAR DATABASE для очистки внутренней базы данных — очищает весь кэш без выхода из сессии, кнопка strong>CLEAR FILES для кэшированных очистки файлов, и ниже можно узнать размер базы данных и кэша файлов (Cache size).
• LOG. На этой вкладке можно собрать логи приложения (см. Общие логи из инженерного меню (Android)). В подразделе 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 в файл общих логов с помощью Write main log to file в подразделе Smart Apps log.
• FEATURES. На этой вкладке переключаются дополнительные и экспериментальные функции eXpress: Smart Apps, интеграция с Vinteo и т.д.
• PUSH. В подразделе Push Services находятся сведения о службах push-уведомлений:
  • push_service_type. Текущая служба push-уведомлений. Если значение UNDEFINED, причины у этого могут быть следующие:
    1. На устройстве отсутствуют требуемые push-службы. Необходимо установить их по возможности.
    2. Приложению не предоставлен доступ к уведомлениям. Нужно предоставить разрешение в настройках ОС для приложения.
    3. Некорректно настроена push-служба на сервере RTS/ETS, см. подробнее здесь.
    Если ничего не помогает, соберите логи приложения и передайте в поддержку eXpress.
  • push_token. Токен соответствующей push-службы. Если он пуст, уведомления работать через эту службу не будут. Может помочь перезапуск приложения.

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

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

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

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

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

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


Инженерное меню веб/десктоп-приложения содержит только логи звонков/конференций и стейт. Если вам нужен общий лог, см. Общие логи из консоли веб-/десктоп-приложения.

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

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

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

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

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

Чтобы получить логи и/или информацию о сетевых запросах по проблеме, которая возникает на экране входа или сразу после входа, откройте веб-приложение в браузере или десктоп-приложение и затем:

1. Откройте консоль браузера или десктоп-приложения:
   • В Chromium-браузере (Chrome, Opera, Edge, Яндекс Браузер и т.д.) или десктоп-приложении нажмите клавишу (Fn +) F12.
   • В браузере Safari на Mac откройте меню Safari > Настройки > Дополнения > Показывать функции для веб-разработчиков, вернитесь в веб-приложение и в меню наверху выберите Разработка > Показать веб-инспектор.
2. В открывшейся справа панели выберите вкладку Console.
3. Воспроизведите проблему, которая возникает на экране входа или сразу после входа в приложение.
4. В логе консоли появится ошибка или несколько ошибок. Нажмите на ссылку в тексте последней ошибки (красного цвета).
5. Вы попадёте на вкладку Network. Здесь щёлкните эту же ошибку в списке запросов.
6. В открывшемся описании ошибки перейдите на вкладку Response.
7. Посмотрите значение Reason — это будет причина ошибки, которую можно сообщить в поддержку. Или вы можете просто сделать скриншоты лога консоли и отправить их.

Серверные логи регистрации или входа в приложение

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

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

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

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

Кроме того, в панели администратора корпоративного сервера в разделе «E-mail» вы можете воспользоваться функцией Тестирование отправки e-mail для отправки пробных писем на любую электронную почту.

Общие логи из инженерного меню (Android)

Чтобы собрать общие логи из инженерного меню приложения на 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 «поделиться», которые нужны при проблемах с этой функцией.
3. Сохраните выбранный лог в файл или отправьте в поддержку.

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

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

1. Откройте консоль браузера/десктопа:
   • В Chromium-браузере (Chrome, Opera, Edge, Яндекс Браузер и т.д.) или в десктопе нажмите клавишу (Fn +) F12.
   • В браузере Safari на Mac откройте меню Safari > Настройки > Дополнения > Показывать функции для веб-разработчиков, вернитесь в веб-приложение и в меню наверху выберите Разработка > Показать веб-инспектор.
2. В консоли нажмите кнопку-шестерёнку наверху, чтобы открыть настройки, и в подразделе Console (Консоль) включите параметр Show timestamps (Отображать временные метки). Таким образом, в консоли будет фиксироваться время событий.
3. Далее выберите вкладку Console (Консоль) для просмотра ошибок или вкладку Network (Сеть) для просмотра сетевых запросов.
4. Вы можете предварительно очистить консоль, в контекстном меню выбрав команду Clear console (Очистить журнал). Воспроизведите проблему. В логе консоли появится ошибка или предупреждение. Сделайте скриншот или сохраните лог консоли целиком командой Save as... (Сохранить как) в контекстном меню.
5. Чтобы сохранить информацию о сетевых запросах в файл HAR, на вкладке Network (Сеть) в контекстном меню выберите команду Save all as HAR with content (Chromium-браузер) или нажмите кнопку Экспортировать (браузер Safari; если кнопка недоступна, перезагрузите страницу и снова воспроизведите ошибку в веб-приложении). Если нужно, сетевые запросы можно предварительно очистить кнопкой Clear (Очистить) наверху.

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

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

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

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

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

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

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

Настольная ОС	Расположение файла
Windows	%USERPROFILE%\AppData\Roaming\Express\log.log
macOS	Библиотека/Logs/Express
Linux	~/.config/eXpress/log.log или /home/ИМЯ_ПОЛЬЗОВАТЕЛЯ/.config/eXpress/logs/log.log (для открытия файла могут понадобиться права администратора)

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

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

Чтобы собрать логи запуска:

1. Закройте десктоп-приложение.
2. Откройте терминал или командную строку вашей ОС и запустите приложение следующей командой: <путь_исполняемого_файла> "--enable-logging=file" "--log-file=\" "--log-level=DEBUG" Рядом с исполняемым файлом приложения появится файл debug.txt. В терминале или командной строке также отобразится лог запуска приложения.
3. Воспроизведите проблему, закройте приложение, отправьте файл debug.txt и скриншот терминала или командной строки в поддержку eXpress на анализ.

Логи звонков и конференций из инженерного меню (Android)

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

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

Логи звонков, конференций и сообщений из инженерного меню (iOS/iPadOS)

Чтобы собрать их:

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

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

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

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

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

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

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

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


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

Клиентские логи Smart App через сбор диагностических данных

Логи Smart App можно собрать через упрощённый сбор диагностических данных. Для способов ниже потребуется открыть инженерное меню приложения.

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

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

1. Откройте инженерное меню через (Чаты >) Настройки (аватар над списком чатов) > О программе и много раз нажмите на логотип, пока не откроется инженерное меню.
2. На вкладке LOG в подразделе Smart Apps log включите Write main log to file.
   Выключите и снова включите этот тумблер, чтобы предварительно очистить логи Smart Apps.
3. Закройте инженерное меню, откройте Smart App, воспроизведите проблему и через кнопку-троеточие в самом Smart App скачайте его логи.

Если проблема наблюдается во время или сразу после запуска Smart App (когда ещё нет кнопки для скачивания логов в самом Smart App):

1. Откройте инженерное меню через (Чаты >) Настройки (аватар над списком чатов) > О программе и много раз нажмите на логотип, пока не откроется инженерное меню.
2. На вкладке LOG в подразделе Smart Apps log включите Write main log to file.
3. Вернитесь на основной экран приложения и нажмите (Чаты >) Настройки (аватар над списком чатов) > О программе и нажмите кнопку Начать сбор диагностических данных внизу.
4. Откройте каталог Smart Apps и попробуйте открыть проблемный Smart App.
5. Не сворачивая приложение и не отключая Интернет, подождите 15 секунд.
6. Вернитесь в раздел О программе и нажмите внизу Остановить и поделиться.

Клиентские логи Smart App на iOS/iPadOS

Как получить логи Smart App из инженерного меню приложения на iOS/iPadOS:

1. Откройте инженерное меню через (Чаты >) Настройки (аватар над списком чатов) > О программе и много раз нажмите на логотип, пока не откроется инженерное меню.
2. Включите настройку Собирать логи SmartApp (Collect Smart apps logs).
   Выключите и снова включите этот тумблер, чтобы предварительно очистить логи Smart Apps.
3. Закройте инженерное меню, откройте Smart App, воспроизведите проблему и через кнопку-троеточие в самом Smart App скачайте его логи.

Клиентские логи Smart App из веб/десктоп-приложения

Как получить логи Smart App из инженерного меню веб/десктоп-приложения на ПК:

1. Откройте инженерное меню через (Чаты >) Настройки (аватар над списком чатов) > О программе и много раз нажмите на логотип, пока не откроется инженерное меню.
2. Включите настройку Собирать логи SmartApp (Collect Smart apps logs).
   Очистите кэш нажатием (Cmd) Ctrl + R, чтобы предварительно очистить логи Smart Apps.
3. Закройте инженерное меню, откройте Smart App, воспроизведите проблему и через кнопку-троеточие в самом Smart App скачайте его логи.

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

Как получить логи Smart App «Главная» и «Сервисы» из инженерного меню приложения:

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

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

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

Как получить логи бота и Smart App с помощью консольных команд:

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

Файл .env с переменными бота/Smart App

Файл конфигурации переменных содержит переменные, определяющие работу бота/SmartApp. Этот файл находится в специальном каталоге на сервере в /opt/express/bots/your_bot (вместо your_bot будет папка с ботом или Smart App).

Также в этом файле может потребоваться включить флаги отладки для записи более подробных логов диагностики в контейнере бота/Smart App (например, DEBUG=true). Подробное описание флагов отладки и когда они нужны см. в комментариях в самом файле .env.

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

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

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

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

Выполните данные шаги, чтобы задать уровень логирования — для примера зададим уровень debug сервису интеграции с Active Directory:

• Docker: docker exec -it cts-ad_integration-1 bin/ad_integration rpc "Logger.configure(level: :debug)" Здесь cts-ad_integration-1 — имя контейнера, а ad_integration — имя бинарного файла.
• Kubernetes: kubectl exec -it {ad-integration} -- bin/ad_integration rpc "Logger.configure(level: :debug)" Здесь {ad-integration} — это имя или id пода.

Должен выдаться ответ ok.

Уровень логирования можно задать только для сервисов с использованием Elixir (ad_int, messaging, trusts и т.д.), сервисы nginx, kafka и т.д. не поддерживают изменение уровня логирования способом выше.

Команды выше сохраняют уровень логирования до перезапуска сервиса. Чтобы сделать уровень логирования постоянным:

• Docker: для определённого контейнера, например, trusts, в файле /opt/express/settings.yaml допишите следующее: trusts_env_override: LOGGER_LEVEL: debug Где trusts — имя контейнера, trusts_env_override — уникальная директива, которая должна быть единственной в файле settings.yaml (по стандарту YAML). После внесения изменений нужно пересобрать контейнеры командой dpl -d trusts
  Чтобы переопределить уровень для всех контейнеров, в файл /opt/express/settings.yaml добавьте следующие строки: logger_level: debug
• Kubernetes: не рекомендуется менять.
Для постоянной работы настоятельно рекомендуется использовать уровень warning, а не debug.

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

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

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

Общие логи сервера и логи контейнеров можно получить не только в панели администратора, но и через консоль — пример для сервиса ad_integration:
cd /opt/express && DPL_PULL_POLICY=never dpl --dc logs --tail=1000 ad_integration > logs.txt

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

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

Базовая информация по сбору логов k8s есть в официальной документации Kubernetes.

Получение логов пода из stdout:

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. Соберите логи: sudo 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. Передайте логи технической поддержке для анализа.

Версия MS Outlook

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

• Outlook для Windows. В меню Файл откройте раздел Учетная запись Office.
• Outlook для macOS. Откройте меню Outlook и выберите О программе.

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

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

• Надстройка Outlook для Windows (клиентская часть). Чтобы просмотреть версию надстройки, наведите указатель мыши на кнопку надстройки.
• OWA-версия надстройки (macOS) (клиентская часть). В главном представлении Outlook для Mac (список писем) нажмите кнопку Получить надстройки. На портале OWA войдите в свой аккаунт и в разделе Управление надстройками выберите надстройку.
• Бэкенд надстройки (серверная часть). Версию бэкенда можно уточнить у системного администратора или специалиста технической поддержки/внедрения eXpress, установившего надстройку.
  Администратору: просмотр версии бэкенда надстройки

  Если есть доступ к бэкенду: http://адрес_сервера_с_бэкендом_надстройки:порт/api/meetings/check
  Если клиентская и серверная части не совпадают по версии, отстающую часть необходимо обновить! Обратитесь в поддержку eXpress для получения помощи с обновлением.

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

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

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

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

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

Файлы с информацией о системе помогают сузить круг возможных причин технических неполадок. Собранную информацию о системе вы можете передать в поддержку 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. Выберите Файл > Сохранить и сохраните файл на рабочий стол.