Skip to main content
Version: Next

Logging

Logging configuration for the restapi component​

Web Modeler's restapi component uses the logback framework for logging. By default, the restapi component logs to the Docker container's standard output. To change the default logging behavior, create a custom configuration file and let the restapi know of it by specifying the following environment variable:

LOGGING_CONFIG=file:/full/path/to/custom-logback-config.xml

Refer to Spring Boot's logging documentation for more information on how to customize the logback configuration for specific use cases like logging to a file.

Enabling DEBUG logging for the restapi component can be useful for troubleshooting purposes, e.g. for debugging Zeebe connection issues.

By default, Web Modeler's restapi component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

SPRING_PROFILES_INCLUDE=default-logging

Logging configuration for the webapp component​

By default, the webapp component logs to the Docker container's standard output.

Logging to a file​

To enable additional log output to a file, adjust the following environment variable:

LOG_FILE_PATH=/full/path/to/log/file.log

Configuring log levels​

To control the verbosity of the logs, adjust the environment variables LOG_LEVEL_CLIENT (browser client) and LOG_LEVEL_WEBAPP (Node.js server).

LOG_LEVEL_CLIENT=DEBUG

The LOG_LEVEL_* options can be found here.

Logging configuration for the websocket component​

By default, the websocket component logs to the Docker container's standard output.

Logging to a file​

To enable additional log output to a file, follow these steps:

  1. Mount a volume to the directory /var/www/html/storage/logs. The logs will be written to a file named laravel.log located inside this directory.
  2. Adjust the following environment variable:
    LOG_CHANNEL=single