Logging information (accumulated and non-accumulated batch)

Non-accumulated batch is a multi-threaded application that processes large numbers of documents, defined by XML records. For this reason, the NA batch log output is formatted in a specific way to make information gathering easier.

All batch processes have a common logging configuration file located in <batch bundle installation folder>/conf/logging. All the configuration is present in file logback-global.xml, its structure and default content are the same as for all other bundles (security, core, composition, etc.).

Each log entry consists of several fields that hold values with different meanings. The number of fields and type of data in each field will be explicitly specified as follows:

For accumulated batch:
<TIMESTAMP>|<LOG_LEVEL>|<CLASS_NAME>|<THREAD_NAME>|<SPECIFIC_MESSAGE>

For NA batch:

<TIMESTAMP>|<LOG_LEVEL>|<CLASS_NAME>|<THREAD_NAME>|<INPUT_ANSWER_ID>|
                                                    <INPUT_FILE_NAME>|<SPECIFIC_MESSAGE>

As in the example above, the fields will be delimited with a "|" character. This allows you to programmatically parse log information from the log file.

Points to note:

  • The maxFileCount setting can be configured in the configuration framework. For detailed information, refer to Modifying log file count.
  • The maxLogFileSize and maxLogFileCount command line options override the defaults present in the logback-global.xml configuration file.
  • The logfile command line option overrides default log file name.

Logging can be configured such that the underlying log file is rolled over at a chosen frequency. See the below link on how to configure the rolling frequency:

https://logback.qos.ch/manual/appenders.html#SizeAndTimeBasedRollingPolicy

More about logging event components called appenders:

https://logback.qos.ch/manual/appenders.html