Jump to: navigation, search

Logging

EX Engage Connector Services writes logs in JSON format to the container's STDOUT. Those logs are expected to be consumed by the log monitoring system (for example filebeat) and moved to a log processing system where they can be queried and analyzed (for example Elastic Search).

EXCS can also write logs to a file on a disk. This functionality is enabled by the environment variables <SERVICE>_LOG_PATH and <SERVICE>_LOG_FILE_NAME.

Environment variable <SERVICE>LOG_LEVEL will be used to define the logging level.

Name Default Mandatory Description
Name Default Mandatory Description
LOG_CONSOLE_ENABLE true NO Specifies if log to console is enabled (default)
LOG_FILE_ENABLE false NO Specifies if log to file is enabled
LOG_FILE_LEVEL
LOG_CONSOLE_LEVEL
INFO NO Log levels
  • OFF - A special level to use in configuration in order to turn off logging.
  • FATAL - A critical service failure or complete inability to service requests of any kind.
  • ERROR - A significant disruption in a request or the inability to service a request.
  • WARN - A non-critical service error or problem that may not require immediate correction.
  • INFO - Service lifecycle events or important related very low-frequency information.
  • DEBUG - Messages that convey extra information regarding lifecycle or non-request-bound events, useful for debugging.
  • TRACE - Messages that convey extra per-request debugging information that may be very high frequency.
  • ALL - A special level to use in configuration to turn on logging for all messages, including custom levels.
LOG_FILE_MAX_BACKUP_INDEX 20 NO Specifies maximum number of log files to keep on disk before rotating.
LOG_FILE_PATH /rup/logs/ccerp.log NO Specifies file to log to.
Note that file is rotating after 50Mb and suffix is added to file at rotation.
For example rotated file might be named ccerp.log.2020-05-19.1
LOG_FILE_SIZE 50M NO Specifies size of log file after which log files should rotate.
LOG_JSON_ENABLE true NO Specifies logging using JSON format
This page was last edited on May 27, 2024, at 07:35.
Comments or questions about this documentation? Contact us for support!