Help center support eXpress

We've collected answers to popular questions to make eXpress easy and convenient to use. Didn't find the answer to your question? Contact our support team.

Bots & SmartApps Logs

Bots & SmartApps Logs

Client-side logs are collected from the user's device; server-side logs are collected from the infrastructure where the bot or SmartApp is hosted.

Bots & SmartApps Client Logs

CTS
eCTS
⚠️ For Administrators: before reproducing the issue and collecting client logs for a SmartApp, you may need to enable debug variables on the server side first — more details.

Collecting SmartApp Logs Without the Engineering Menu

You can collect a SmartApp log and send it to support directly from the app menu — the ellipsis button in the open SmartApp. The engineering menu is not required. The available commands depend on how the administrator configured the SmartApp:

  • If a separate support app is assigned, the log is recorded from the moment the SmartApp opens, and the Contact Support command opens that app and passes it an archive with the log. A screenshot is attached to the log if it is enabled by the administrator and screenshots are allowed in your organization. In this case, there is no separate command for exporting the log.
  • If there is no support app, but the administrator has enabled continuous log recording, Share Logs appears in the menu — the log is exported to you, and you attach it to your support request yourself.
  • If continuous recording is disabled, recording is started manually: Start Log Collection, then reproduce the issue and tap Stop Log Collection.
Available in the server software, web/desktop app and on iOS starting from version 3.72, and on Android starting from version 3.73. If you need a log from the very start of SmartApp while continuous recording is off, see “SmartApp Log Since Launch”.

Collecting Bots & SmartApps Client Logs via “About” Screen

Bots and SmartApps logs are available via “About” Screen.

For bot diagnostics, client logs do not provide enough information — server logs will definitely be required.

SmartApp Log Since Launch

It is needed if an error occurs immediately when opening SmartApp and collecting the log via the ellipsis is not possible. There are two ways:

  • Ask the administrator to enable persistent log recording for this SmartApp. The log will be written each time SmartApp opens: reproduce the error and export the log using the ellipsis button.
  • If the administrator is unavailable, collect diagnostics through the “About” screen: Settings > About > Start diagnostic data collection, open SmartApp and wait 15 seconds, then About > Stop and share.

Server Logs for Bots & SmartApps

CTS
eCTS

The instructions below are intended for standard eXpress bots hosted in containers. Log collection for bots created by third-party developers might be done differently. In such cases, contact the bot developer directly to find out how to collect diagnostics for it.
For Administrators: Debug Settings for Bots/SmartApps
  1. If necessary, change the debug variables in the file /opt/express/bots/your_bot/.env and restart the bot/SmartApp and Worker containers.
    ⚠️ Debug variables are not available in all bots and SmartApps.
    Debug Variable Description
    DEBUG=true|false Enables verbose logging for the main bot or SmartApp components.
    IMAP_DEBUG=true|false Only for Email SmartApp: enables verbose logging for the IMAP client. Also requires DEBUG=true.
    EXCHANGE_DEBUG=true|false Only for Email/Calendar SmartApps: enables verbose logging for the Exchange client. Also requires DEBUG=true.
For Administrators: Collecting Server Logs for Bots/SmartApps
  1. Connect to server for collecting logs. Identify bot/SmartApp container name (last column): docker ps
    Some SmartApps might have two containers (main and worker). In such cases, logs from both SmartApp containers are required.
  2. Export logs: docker logs CONTAINER_NAME > /tmp/bot_logs.txt 2>&1
  3. Download the file: scp user@your.server:/tmp/bot_logs.txt
For Administrators: .env & docker-compose.yaml Files
  1. If requested by support, send them the /opt/express/bots/your_bot/.env file (cleared of sensitive data) and the docker-compose.yaml configuration file from /opt/express/bots/your_bot/.