OpenLM components’ logging parameters – KB4018
The OpenLM system generates detailed log files, to monitor its operation. Log file generation is supported by all OpenLM software components.
OpenLM Server (through OpenLM EasyAdmin web interface)
It is generally recommended to keep the logging level at ‘ERROR’ in normal working mode, as excessive logging may consume unnecessary resources from the OpenLM Server machine. For this reason a temporary change of logging level from ‘ERROR’ to ‘ALL’ and back to ‘ERROR’ has been implemented via the OpenLM EasyAdmin web interface. In order to do so, Click the EasyAdmin ‘start’ button → Administration. The Administration window opens. Now select ‘System & Security’ → “Logs and Reports” → check “Enable DetailedLogging” → select “All Logs” → select time to log (5 minute default) → and click “Start Logging”, and select the period length for which the OpenLM Server would switch to ‘ALL’ level logging.
The server log files are located by default under the server installation folder, i.e.: C:\Program Files(x86)\OpenLM\OpenLM Server\Log
Right click the Agent icon to open the OpenLM Agent configuration form. Set the logging level to ALL and apply the changes. Since the OpenLM Agent supports terminal server environment, the log files are written under the user’s Application Data folder. For example:
Operating System: Pre-Vista C:\Documents and Settings\Application Data\OpenLM
From the Windows Start menu, follow this path to the the OpenLM Agent logs: Start → OpenLM → OpenLM Agent Logs Folder.
The Agent’s logging level can also be set when distributing the Agent during the silent installation procedure.
The OpenLM Broker is a Java software component. It can be installed on any Java-compatible environment. In order to set the Broker logging level, please:
- Open the Broker configuration tool
- Select the Advanced Settings node
- Change the OpenLM Broker Log Levels selection drop-menu to ALL
The OpenLM Broker log files are normally located in the installation folder, i.e.:
Windows OS: this is C:\Program Files\OpenLM\OpenLM Broker\Logs
In UNIX/Linux systems the logs are located in the predefined Broker installation folder.
Limiting Broker log file sizes
Users can change the OpenLM Broker’s logging parameters by modifying the log configuration file. This includes:
- Log files’ maximal size
- The rotation of the log files
- Format of each row in the log file
The log configuration file is typically located under the software installation folder, i.e.:
C:\Program Files (x86)\OpenLM\OpenLM Broker\log4j_broker.properties
For example, the following (default) configuration will yield cyclic ‘ERROR’ level logging for as much as 20 files, 20MB each for log files of type broker_logger.txt:
log4j.rootLogger=ERROR, myAppender ... log4j.appender.myAppender.MaxFileSize=20MB log4j.appender.myAppender.MaxBackupIndex=10 log4j.appender.myAppender.File=C:/Program Files (x86)/OpenLM/OpenLM Broker/logs/broker_logger.txt
The Easyadmin proxy log files are located by default under:
Pre-Vista: C:\Documents and Settings\All Users\Application Data\OpenLM
The logging parameters can be changed by editing this file:
C:\Program Files (x86)\OpenLM\OpenLM Server\WebApps\EasyAdmin2\config.xml
The OpenLM Router logs will be in the selected installation folder, in the ‘logs’ directory.
The adjacent log4j.properties file controls the names, sizes and logging level of the log files.
The OpenLM Data Migration Tool can transfer OpenLM information between different databases.
The Data Migration log file is located by default in the folder:
Pre-Vista: C:\Documents and Settings\Application Data\OpenLM
DB upgrade log files are created during the upgrade of a DB from an older version of OpenLM, usually as part of a software upgrade. The log files’ location is:
Pre-Vista: C:\Program Files\OpenLM\OpenLM Server\bin\DBUpgrade_Log.txt
Post-Vista: C:\Program Files (x86)\OpenLM\OpenLM Server\bin\DBUpgrade_Log.txt