Поддержка

Собрали ответы на популярные вопросы, чтобы пользоваться eXpress было легко и удобно. Не нашли ответ на свой вопрос? Свяжитесь с нашей поддержкой.

Логи ботов и SmartApps

Логи ботов и SmartApps

Клиентские логи собираются с устройства пользователя; серверные — с инфраструктуры, где размещён бот или SmartApp.

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

CTS
eCTS
⚠️ Администратору: перед воспроизведением проблемы и сбором клиентских логов SmartApp может потребоваться предварительно включить переменные отладки на стороне сервера — подробнее.

Сбор логов SmartApp без инженерного меню

Собрать лог SmartApp и передать его в поддержку можно прямо из меню самого приложения — кнопка-троеточие в открытом SmartApp. Инженерное меню для этого не нужно. Набор команд зависит от того, как настроил SmartApp администратор:

  • Если назначено отдельное приложение поддержки, лог пишется с момента открытия SmartApp, а команда Связаться с поддержкой открывает это приложение и передаёт в него архив с логом. Снимок экрана прикладывается к логу, если его включил администратор и снимки экрана разрешены в вашей организации. Отдельной команды для выгрузки лога в таком случае нет.
  • Если приложения поддержки нет, но администратор включил постоянную запись логов, в меню появляется Поделиться логами — лог выгружается вам, и вы прикладываете его к обращению сами.
  • Если постоянная запись выключена, запись включается вручную: Начать сбор логов, затем воспроизведите проблему и нажмите Остановить сбор логов.
Доступно в серверном ПО, веб-/десктоп-приложении и на iOS с версии 3.72, на Android — с версии 3.73. Если нужен лог с самого запуска SmartApp, а постоянная запись выключена, см. «Лог SmartApp с момента запуска».

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

Логи для диагностики ботов и SmartApps собираются через экран «О программе».

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

Лог SmartApp с момента запуска

Нужен, если ошибка возникает сразу при открытии SmartApp и собрать лог через троеточие не получается. Способа два:

  • Попросите администратора включить для этого SmartApp постоянную запись логов. Лог будет писаться при каждом открытии SmartApp: воспроизведите ошибку и выгрузите лог через кнопку-троеточие.
  • Если администратор недоступен, соберите диагностику через экран «О программе»: Настройки > О программе > Начать сбор диагностических данных, откройте SmartApp и подождите 15 секунд, затем О программе > Остановить и поделиться.

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

CTS
eCTS

Инструкции ниже предназначены для стандартных ботов eXpress, размещённых в контейнерах. Сбор логов ботов, созданных сторонними разработчиками, может осуществляться иначе. В таком случае обратитесь напрямую к разработчику бота, чтобы узнать, как собрать по нему диагностику.
Администратору: параметры отладки ботов и SmartApps
  1. При необходимости измените переменные отладки в файле /opt/express/bots/your_bot/.env и перезапустите контейнеры бота/SmartApp и Worker.
    ⚠️ Переменные отладки есть не во всех ботах и SmartApps.
    Переменная отладки Описание
    DEBUG=true|false Режим подробного логирования для основных компонентов бота или SmartApp.
    IMAP_DEBUG=true|false Только для Email SmartApp: режим подробного логирования для клиента IMAP. Также требуется значение DEBUG=true.
    EXCHANGE_DEBUG=true|false Только для Email/Calendar SmartApps: режим подробного логирования для клиента Exchange. Также требуется значение DEBUG=true.
Администратору: сбор серверных логов ботов и SmartApps
  1. Подключитесь к серверу для сбора логов. Определите имя контейнера с ботом/SmartApp (последний столбец): docker ps
    Некоторые SmartApps могут иметь два контейнера (основной и worker). В таком случае потребуются логи обоих этих контейнеров SmartApp.
  2. Экспортируйте логи: docker logs CONTAINER_NAME > /tmp/bot_logs.txt 2>&1
  3. Скачайте файл: scp user@your.server:/tmp/bot_logs.txt
Администратору: файлы .env и docker-compose.yaml
  1. Если поддержка запросит, пришлите ей файл /opt/express/bots/your_bot/.env (очистив от чувствительных данных) и конфигурационный файл docker-compose.yaml из /opt/express/bots/your_bot/.