Logging and Log Files

Introduction

Log files are the main information source for the administrator about the activities of the system and potential problems of the system. The administrator should have a look at the log files on a regular basis. There may be problems that do not appear on the user interface, but are reported in the log file.

The standard path for the log files is <JBOSS_HOME>/standalone/log.

Log Files

The location of the log files and the logging behavior can be configured in the respective configuration files:

cm6-config.properties, cm6-cmrf-config.properties (JBoss EAP / Wildfly standalone installations with or without CMRF)
cm6-domain-config.properties
(JBoss EAP cluster installation)

Log File Types

The following log files are used:

access.log
Access to and usage of the Web Client is logged. In the current configuration, a separate access.log file is written every day.
How to activate the access.log
In a default installation, the following lines in the configuration file, cm6-<DB>.xml, cm6-cmrf-<DB>.xml or cm6-dwh-<DB>.xml are commented out. By commenting them in, you can start access logging in your ConSol CM system.
<server name="default-server" default-host="default-host">
<http-listener name="http" socket-binding="http" max-post-size="104857600" redirect-socket="https" enable-http2="true"/>
<ajp-listener name="ajp" socket-binding="ajp"/>
<host name="default-host" alias="localhost">

<location name="/" handler="welcome-content"/>
<filter-ref name="server-header"/>
<filter-ref name="x-powered-by-header"/>
<http-invoker security-realm="ApplicationRealm"/>
</host>
</server>
cmrf.log
Messages pertaining to CMRF (ConSol CM Reporting Framework), i.e., messages regarding the data transfer operations from the ConSol CM database to the CMRF database (DWH).
cmweb.log
Messages pertaining to the ConSol CM Web Client.
ctx.log
Contains messages from the Spring Framework.
errors.log
Contains only messages that have at least the log level ERROR.
index.log
Messages pertaining to the Indexer.
mail.log
Contains log messages from the email subsystem.
operationtimes.log
Only used when it has been enabled. Contains timing information for requests in order to identify possible performance bottlenecks.
How to produce good output in operationtimes.log
In order to produce concise and informative output in this log file, you have to create a logger for the respective ConSol CM module which is set to DEBUG mode.
Example:
<logger category="com.consol.cmweb.client.webapp.timemeasure.log.Log4jOperationLogger">
<level name="DEBUG"/>
<handlers>
<handler name="OPERATION_TIMES"/>
</handlers>
</logger>
operationtimes-db.log
Contains information about database access times of atomic operations in order to identify possible performance bottlenecks. This logging is configured using the system properties cmas-core-server, dao.log.threshold.milliseconds and cmas-core-server, dao.log.username.
operationtimes-rest.log
Contains the operation times for REST requests. The request URL and the time needed to process the request are logged on DEBUG level. The logging is configured using the system properties cmas-restapi-core, request.log.threshold.milliseconds and cmas-restapi-core, request.log.username
security.log
Contains log messages which are related to security, authorization and authentication, e.g. log entries about Kerberos authentication.
server.log
The general log file that contains all messages, by default, with at least log level INFO.
session.log
Contains messages about logins (session starts) and session timeouts of ConSol CM users.
sql.log
Contains log entries about SQL statements coming from hibernate if it is set to DEBUG level (by default it is set to INFO).
support_libs_errors.log
Contains errors which are thrown by support libs but are properly handled by the ConSol CM application (this method keeps the server.log clean).
timer-manager.log
Contains additional log messages written in log level DEBUG when workflow timers are activated or deactivated. Information about the escalation date is logged, too.
track_jersey.log
Contains log messages which are related to CM/Track.
tx.log
Contains Spring Framework transactions related log messages.
unit-deletion.log
Contains information regarding the deletion of customers.
workflow.log
Information about activated/reinitialized/deactivated timers is logged with level INFO and all debug output related to the workflow engine is written to this dedicated file.

Admin Tool-Specific Log Files

Two log files report information which are specific for the Admin Tool. The CM logging configuration might have to be adapted during a system update from a CM version lower than 6.11 to 6.11.

audit.log
Reports login/logout operation and all operations which have been made using the Admin Tool:
- configuration changes
- creation of new objects
- deletion of objects
- reopening of tickets
Reports login/logout operation and operations which have been performed using the Process Designer, e.g.,
- deployment of a workflow
transfer.log
Reports information about the export / import of scenarios.

Log File Structure

In the default configuration, log file entries have the following syntax:

Date Timestamp Loglevel [Logger] Message

Example for a log file entry (successful start of ConSol CM in JBoss):

2017-10-11 13:52:44,526 INFO [reemarker.FreeMarkerConfigurer] [-] ClassTemplateLoader for Spring macros added to FreeMarker configuration

The components of the message:

Date:
October 11th, 2017
Timestamp:
13:52:44
Loglevel:
INFO
Logger:
reemarker.FreeMarkerConfigurer
Name of a Java class, not complete (only last 30 characters), the real name would be Freemarker.FreeMarkerConfigurer
Message:
ClassTemplateLoader for Spring macros added to FreeMarker configuration

Simple messages, and those reporting a successful operation, often have only one line.

When errors are reported (log level ERROR), you might find stack traces in the logs. Please contact one of our ConSol CM consultants or our ConSol CM support team for help.