IBM FileNet P8, Version 5.2.1

FileNet Deployment Manager log files

Use the FileNet® Deployment Manager log file to troubleshoot migration and deployment problems that are related to FileNet Deployment Manager tasks.

FileNet Deployment Manager log file location

The log file for FileNet Deployment Manager is created by using Apache log4j. By default, this file is located in the working directory that is used to start FileNet Deployment Manager, in the cpe_install_path/ContentEngine/tools/deploy/deployment.log path.

For example, if FileNet Deployment Manager is installed in a Windows environment and is started from the Start menu, then the default path of the log file is the installation directory for Content Platform Engine tools installation, in the C:\Program Files (x86)\IBM\FileNet\ContentEngine\tools\deploy\deployment.log path.

For more information about enabling logging with the Apache log4j logging utility, see Specifying Java runtime options for FileNet Deployment Manager.

The Apache log4j configuration file

The Apache log4j configuration file contains logging settings. You can create your own log4j configuration file and add it to the working directory or use the provided default log4 configuration file. The configuration file that is used is determined by the setting of the Java system property log4j.configuration.

If the log4j.configuration Java system property is not set or specifies a file that does not exist, FileNet Deployment Manager attempts to use the log4j.properties file in the current working directory, which is usually the directory where FileNet Deployment Manager is installed. FileNet Deployment Manager includes a default log4j.properties file in the following path. In the path, the cpe_installation_path variable is replaced by the Content Platform Engine installation directory, and the n.n.n variable is replaced by the version, release, and modification release for the current version of FileNet Deployment Manager, such as 5.2.0 or 5.2.1.

cpe_installation_path/ContentEngine/tools/deploy/features/com.filenet/deployment.rcp.feature_n.n.n/rootfiles/log4j.properties

For more information about modifying the log4j configuration file, see Working with the Apache log4j Configuration File.

Setting logging levels

The level of detail in the log file is determined by the settings in the Apache log4j configuration file, such as the log4j.properties file. By default, the logging level is set to INFO. However, different types of activities might require a change to this setting.

If higher throughput rates are a priority over informational log entries, change the logging level from INFO to WARN. The following example shows the affected configuration within the log4j.properties file:

log4j.logger.com.filenet.deployment = WARN
log4j.logger.filenet_error.api = WARN
log4j.logger.filenet_error.api.com.filenet.apiimpl.imex.LoggingStream = WARN

If detailed logging is required to investigate and diagnose correctable issues such as data integrity violations, then the more detailed DEBUG logging level can be used. In general, setting the logging levels to DEBUG is done only at the request of IBM Software Support. Carefully consider the consequences of setting the logging levels to DEBUG. Using the DEBUG logging level can cause large amounts of data to be generated and can affect the performance of your production system. The following example shows the affected configuration within a log4j.properties file:

################################################################################ 
# Loggers 
# Set log level to either one of OFF/DEBUG/INFO/WARN/ERROR/FATAL/ALL 
# Child logger's value overwrites parent logger's one. 
# If a logger is not specified, it inherits its value from its parent logger.
################################################################################
log4j.logger.com.filenet.deployment = debug
# the line above enables FileNet Deployment Manager tracing
log4j.logger.filenet_error.api = debug
log4j.logger.filenet_error.api.com.filenet.apiimpl.imex.LoggingStream = debug
log4j.logger.filenet_tracing.api = debug
# the line above enables the Content Engine Java API tracing

For more information about modifying the log4j configuration file, see Working with the Apache log4j Configuration File.