IBM FileNet P8, Version 5.2

Working with the Apache log4j Configuration File

The Apache log4j package (org.apache.log4j) provides a means for logging behavior, priority levels, and output formats with no need to change or recompile application code. Upon application initialization, log4j looks for a configuration properties file called log4j.properties in a Java™ 2 Enterprise Edition (J2EE) module's classpath. The lookup takes place at static initialization time and the properties file can be written in XML or in a Java properties format (keyword=value pairs). In this section, we will describe how to modify a provided sample file to configure logging for your client application.

Important: If you choose to leverage the server side implementation of the TraceLoggingConfiguration object to enable trace logging, you cannot also use the log4j.properties file to provide additional logging configuration. However, you can instruct the system to bypass the server implementation, and only use the settings in the log4j.properties file, by specifying the "-DskipTLC=true" command line option. This may be useful when troubleshooting specific server startup issues, such as when the Global Configuration Data (GCD) database is not able to load.

Sample log4j Configuration Files

During Content Engine installation, two log4j sample files are placed on the system in the ContentEngine\config\samples\ folder:

log4j.properties.client — A Java format file containing client configuration settings.
log4j.xml.sever — An XML format file containing server configuration settings.

In order to leverage the log4j functionality, these configuration files should be copied into the ContentEngine\config\ folder as log4j.properties and log4j.xml, respectively, with their suffix extensions removed. You can then make adjustments as necessary to the copied configuration files in the ContentEngine\config\ folder, depending on your requirements. Upon application initialization, log4j performs a lookup operation to locate and automatically read the ContentEngine\config\log4j.properties file.

Note: If you do modify the trace logging settings within the log4j.properties client configuration file during run time, you do not need to restart the application server.

The following sections describe how to configure log4j by modifying various statements in the sample log4j.properties file. For information on working with an XML format file, refer to the Apache log4j documentation.

Modifying the log4j Configuration File

Logging behavior (what we want to log, enabling and disabling logging, output targets, and formatting of output) is configurable and can be set at run time. In a Java format configuration file, the log4j package looks for keyword=value pairs to control the logging behavior. You determine the subsystems for which you want to perform trace level logging and the level of error logging detail to include in the log entries, and then specify the appropriate values in the properties file. (Refer also to Use Level Inheritance.) You can configure log4j to record its log entries to many types of output locations, both local and remote, and specify the type of output location to use through configuration options.

Specify the Root Logging Operation for Gathering Data

The rootLogger log4j keyword represents the core class of the log4j package and is the highest entity in the logger hierarchy. Its assigned level of ERROR is used by any child logger that does not have an explicitly set level of its own or does not have an ancestor in the logger hierarchy from which to inherit.

The rootLogger is the first keyword specified in the log4j.properties file, as follows:

################################################################################
# Root logger
################################################################################
log4j.rootLogger=off, FileNetNullAppender

In the provided sample file, the rootLogger is also configured to use the FileNetNullAppender. This is explained in more detail in the following subsection.

Specify Where the Data Will Be Written Using Appenders

An appender sends formatted log entries to a specified output destination. Destination types can be a file, a console, redirected to a Windows Event logger, forwarded to a remote log4j server, and so on. (See the log4j documentation for all of the output destination options.)

You can attach more than one appender to a single logger. For example, you might want to write the output to the console, but also to a backup file that can be retained. The logger writes enabled logging requests to each appender.

In the provided log4j.properties file, FileNet® specifies the following default appenders:

FileNetNullAppender — Causes log messages to be formatted, but not written anywhere (default behavior for the log4j varia.NullAppender).
FileNetConsoleAppender — Sends log messages to the default log4j console (ConsoleAppender).
FileNetErrorAppender — Writes WARN, ERROR, and INFO level error messages to the /p8_api_error.log file.
FileNetTraceAppender — Writes DEBUG level and all trace log messages to the /p8_api_trace.log file.
FileNetErrorRollingAppender — Whenever the specified FileNetErrorAppender file exceeds the maximum specified size of 100MB, a backup of the file is written to the default log4j RollingFileAppender location.
FileNetTraceRollingAppender — Whenever the specified FileNetTraceAppender file exceeds the maximum specified size of 100MB, a backup of the file is written to the default log4j RollingFileAppender location.

################################################################################
# Appenders
################################################################################
#=== FileNetNullAppender
log4j.appender.FileNetNullAppender=org.apache.log4j.varia.NullAppender
#=== FileNetConsoleAppender
log4j.appender.FileNetConsoleAppender=org.apache.log4j.ConsoleAppender
...
#=== FileNetErrorAppender
log4j.appender.FileNetErrorAppender=org.apache.log4j.FileAppender
log4j.appender.FileNetErrorAppender.File=/p8_api_error.log
...
#=== FileNetTraceAppender
log4j.appender.FileNetTraceAppender=org.apache.log4j.FileAppender
log4j.appender.FileNetTraceAppender.File=/p8_api_trace.log
...
#=== FileNetErrorRollingAppender
log4j.appender.FileNetErrorRollingAppender=org.apache.log4j.RollingFileAppender
log4j.appender.FileNetErrorRollingAppender.File=/p8_api_error.log
log4j.appender.FileNetErrorRollingAppender.MaxFileSize=100MB
log4j.appender.FileNetErrorRollingAppender.MaxBackupIndex=1
...
#=== FileNetTraceRollingAppender
log4j.appender.FileNetTraceRollingAppender=org.apache.log4j.RollingFileAppender
log4j.appender.FileNetTraceRollingAppender.File=/p8_api_trace.log
log4j.appender.FileNetTraceRollingAppender.MaxFileSize=100MB
log4j.appender.FileNetTraceRollingAppender.MaxBackupIndex=1
...

For more information about appenders, see Trace Log Appender Names.

Specify the Format of the Gathered Data Using Layout

The configuration settings for an Appender may include the layout keyword. The Layout abstract class is used to format the Appender output according to specified criteria and is assigned using other keywords:

PatternLayout – The PatternLayout keyword is specified when you want to format the output using a provided ConversionPattern. For example, a ConversionPattern of:

%d [%t] - %5p %m\r\n

yields output similar to:

2006-11-30 17:36:12,273 [main] - INFO TTLStreamReaper task has started.
2006-11-30 17:36:12.791 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
2006-11-30 17:36:12.801 [cwrap] - WARN Document/Checkin ConnectionWrapper.send send.after

When the PatternLayout keyword is used, the ConversionPattern keyword is used to identify the pattern of elements that will be written to the appender using the gathered data. In the provided sample file, ConversionPattern is assigned using the following elements:

Pattern	Description	Notes®
`%d`	Prints timestamps both as relative milliseconds and as a formatted date (in this case, the default of ISO8601 format for GMT time: YYYY-MM-DD HH:MM:SS:NNS).	Logging relative milliseconds is helpful for quickly determining performance stuff (elapsed time) and the formatted date is good for matching up with external events.
`[%t]`	Prints the Java thread name that is logging the entry, surrounded by square brackets.
`-`	Prints a hyphen character as a separator between the log entry data and the message text.
`%5p`	Prints the error logging level of the entry.	For example, if you set the level to `WARN`, the word “`WARN`? prints in the log entry.
`%m\r\n`	Prints the message text followed by a platform specific line break character.

XMLLayout – The XMLLayout keyword is used to specify that in addition to the text file output, the same output should be written to a file in structured XML format. If you are planning to use a post-processing tool (such as Chainsaw) that reads XML, specifying XMLLayout creates the XML file.
When the XMLLayout keyword is used, the LocationInfo keyword is used to indicate that the file name and line number of the statement at the origin of the log statement should be output (true); or false (the default), no location information should be generated by this layout.

In the provided log4j.properties file, layouts with ConversionPatterns are defined for the following appenders:

#=== FileNetConsoleAppender
...
log4j.appender.FileNetConsoleAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetConsoleAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n
#=== FileNetErrorAppender
...
log4j.appender.FileNetErrorAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetErrorAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n
#=== FileNetTraceAppender
...
# The statement for TraceLayout that is commented out below is the layout that the 
# TraceLoggingConfiguration framework on the server uses. To use this layout, 
# the Jace.jar must be present in the classpath.
#log4j.appender.FileNetTraceAppender.layout=com.filenet.apiimpl.util.TraceLayout
# If you are using the FileNet TraceLayout, comment out the following 2 lines.
log4j.appender.FileNetTraceAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetTraceAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n
#=== FileNetErrorRollingAppender
...
log4j.appender.FileNetErrorRollingAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetErrorRollingAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n
#=== FileNetTraceRollingAppender
...
# The statement for TraceLayout that is commented out below is the layout that the 
# TraceLoggingConfiguration framework on the server uses. To use this layout, the 
# Jace.jar must be present in the classpath.
#log4j.appender.FileNetTraceRollingAppender.layout=com.filenet.apiimpl.util.TraceLayout
# If you are using the FileNet TraceLayout, comment out the following 2 lines.
log4j.appender.FileNetTraceRollingAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetTraceRollingAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

Choose the Custom Layout Class or a ConversionPattern

In the above example, statements are provided for both FileNetTraceAppender and FileNetTraceRollingAppender. You can use these statements to instruct the system to use the custom FileNet layout class, com.filenet.apiimpl.util.TraceLayout, to format trace output. This layout class is used when the server automatically configures log4j based on the TraceLoggingConfiguration object. If you have instructed the system to bypass the TraceLoggingConfiguration implementation, but would still like trace output to be formatted in the same manner as if TraceLoggingConfiguration were in use, uncomment the statements that specify layout=com.filenet.apiimpl.util.TraceLayout and comment out the two statements specifying the conversion pattern. In addition, be sure that the Jace.jar file is present in the startup classpath.

Specify the Error Logging Operations

The logger class is responsible for handling most of the log operations. You can set the level of a logger to any of the normal, special, or custom levels available. (When assigning levels, refer to Performance Considerations.) If you do not explicitly set the logger’s level, it inherits its level according to the log4j inheritance rules.

In the sample log4j.properties file, FileNet provides configuration settings for the default error logger filenet_error, as well as the API subsystem (commented out):

################################################################################
# Error Loggers:
#
# Set log level to either one of off/fatal/error/warn/info.
# Child logger's value overwrites parent logger's value.
# If a logger is not specified, it inherits its value from its parent.
# By default, error logging is set to level ERROR.
################################################################################
# Don't comment out the following line since it has appenders.
log4j.logger.filenet_error = error, FileNetConsoleAppender, FileNetErrorRollingAppender, FileNetTraceRollingAppender
#=== SubSystem: api
# Uncomment to set error logging level to WARN.
#log4j.logger.filenet_error.api = warn

Select the Error Logging Level

The error logging level reflects the type of error logging you want to occur. Apache log4j supports 5 normal levels (WARN, DEBUG, FATAL, ERROR, and INFO) and 2 special logging levels (ALL and OFF), as well as custom levels.

You can disable logging by changing the logging level in the log4j.properties file to OFF. For example:

#log4j.logger.filenet_error.api = off

If you do not want to disable all logging activity, then change the logging level to ERROR instead of OFF.

In the sample log4j.properties file, the default error logger "filenet_error" is assigned the ERROR level of logging, and the error logger for the API subsystem is assigned the WARN level (commented out):

...
log4j.logger.filenet_error = error, FileNetConsoleAppender, FileNetErrorRollingAppender, FileNetTraceRollingAppender
#=== SubSystem: api
# Uncomment to set error logging level to WARN.
#log4j.logger.filenet_error.api = warn

The descriptions below reflect the configuration options used in the sample log4j.properties file. (For information about other levels and about defining custom levels for your environment, refer to the log4j documentation.)

Level	Description
`WARN`	Requests logging for potentially harmful situations. Provides sufficient info for debugging (specific RPC names, frequencies, and durations) but no detail.
`DEBUG`	Requests logging for fine grained informational events that are most useful to debug an application. `DEBUG` logs the same information as `WARN` but with additional detail. You can also limit the amount of detail. For example, if you specify a RemoteCommand-only logger to log at the `DEBUG` level, you'll get specific RPC names, frequencies, durations, parameters, and return values. However, if you specify logging detail for all Content Java API activity, you'll get the most detail but the additional info logged may not be that helpful for resolving problems. Keep in mind that the more detail you collect, the more severe the performance impact.
`ERROR`	Requests logging exceptions thrown from within the API (internally caught exceptions are logged at `DEBUG` level).
`FATAL`	Requests logging for only very severe error events that will presumably lead the application to abort.
`INFO`	Requests informational messages that describe the progress of the application at a coarse grained level.

Use Level Inheritance

Apache log4j supports level inheritance through a hierarchy structure. Inheritance guarantees that every logger is assigned a level, even if one is not explicitly specified. If no level assignment is made for a logger, it inherits its level from its parent in the logger hierarchy. If the parent has no level assignment, the hierarchy is searched upward for the closest inheritable level. The root logger always has an assigned level to assure that a level is always available. For more information about level inheritance, refer to the log4j documentation.

Specify the Subsystems to Trace

Trace logging is supported for a variety of FileNet P8 operations which are organized into logical subsystems, such as operations pertaining to the Content Engine Java API, the Global Configuration Database, or application authentication. Each supported subsystem is represented by an abbreviation (API, GCD, SEC, and so on) which is used to identify that particular subsystem in the output trace log file.

In the sample log4j.properties file, FileNet disables trace logging operations by default, but defines specific settings for the API subsystem if they should become necessary (commented out):

################################################################################
# Trace loggers:
#
# Setting log level to "off" will turn off trace logging.
# Setting log level to "debug" will turn on trace logging.
#
# Child logger's value overwrites parent logger's value.
# If a logger is not specified, it inherits its value from its parent.
# By default, trace logging is off. 
#
# The general message trace logging has a hierarchy of three detail levels represented with
# hierarchical logger names:
#    ...detail.moderate.summary  -- Enables a summary level of tracing
#    ...detail.moderate          -- Enables a moderate level of tracing
#    ...detail                   -- Enables the most detailed level of tracing
#
# Uncomment corresponding lines to turn tracing on.  To enable trace logging
# for all subsystems and all flags, set the level of the filenet_tracing
# logger to debug.
#
# Here are the trace flags used for each sub system.  For message tracing, enable the line
# corresponding to the desired detail level.
#    log4j.logger.filenet_tracing.<SubSystem>.timer                   = debug
#    log4j.logger.filenet_tracing.<SubSystem>.detail.moderate.summary = debug
#    log4j.logger.filenet_tracing.<SubSystem>.detail.moderate         = debug
#    log4j.logger.filenet_tracing.<SubSystem>.detail                  = debug
#
# For example:
#    log4j.logger.filenet_tracing.api.detail.moderate = debug
################################################################################
# Don't comment out the following line since it includes an appender.
log4j.logger.filenet_tracing = off, FileNetTraceRollingAppender

#=== SubSystem: api
#
# The "api" subsystem does not emit timer information, so you will not get any additional information 
# about timing from the "timer" trace logging on the client. Round-trip timing is available as part of 
# "summary" logging.  "timer" information is available for selected internal operations in the CE server.
#
# Uncomment one or more lines to enable tracing.
#log4j.logger.filenet_tracing.api                          = debug
#log4j.logger.filenet_tracing.api.timer                    = debug
...

For a list of subsystems and their abbreviations, see the table of Supported FileNet P8 Subsystems.

Configure the Amount of Data to Trace

FileNet supports three trace logging levels (SUMMARY, MODERATE, and DETAIL) that are used to specify the amount and type of trace data to collect for a subsystem. In the sample Java format log4j.properties file, FileNet provides definitions for performing each level of trace logging for the API subsystem. If trace logging should become necessary for the API subsystem, simply uncomment the line corresponding to the level of trace logging desired:

...
# Remove the comment corresponding to the desired detail level
#log4j.logger.filenet_tracing.api.detail.moderate.summary  = debug
#log4j.logger.filenet_tracing.api.detail.moderate          = debug
#log4j.logger.filenet_tracing.api.detail                   = debug

For more information about trace logging levels, see the table of Trace Logging Settings.

Enabling log4j Logging

You can enable Content Engine Java API logging in one of two ways: by pointing to a log4j.properties file using a Java Virtual Machine (JVM) argument or packaging the log4j.properties file inside a JAR file. When you need to make a change to your log4j.properties configuration file, using a JVM argument does not require you to stop the application, repackage your modified file, and restart the application, as the JAR file approach does. The steps for each approach are described in this section.

To enable Content Engine Java API logging using a JVM argument, follow these steps:

Copy the provided sample file ContentEngine\config\samples\log4j.properties.client to ContentEngine\config\log4j.properties.
Make sure that you remove the ".client" suffix extension from the copied file.
Modify the ContentEngine\config\log4j.properties file as necessary for your application logging needs.
From the command line on the console, enter a JVM argument that specifies the location of the log4j configuration file, for example:
-Dlog4j.configuration=location

where location is the path to your modified log4j.properties file.

To enable Content Engine Java API logging using a JAR file, follow these steps:

Create a completely new JAR file with a unique name (for example, mylog4j.jar).
Note: Although creating a new JAR file is not required, it is recommended. Having a separate JAR file with a unique name will help you remember that this JAR file contains your unique logging configuration.
Copy the provided sample file ContentEngine\config\samples\log4j.properties.client to ContentEngine\config\log4j.properties.
Make sure to remove the ".client" suffix extension from the copied file.
Modify the ContentEngine\config\log4j.properties file as necessary for your application logging needs.
Add the ContentEngine\config\log4j.properties file at the top level (not in a subdirectory) of your new JAR file.
Add the JAR file to your classpath as you would any other application JAR file.

On application initialization, log4j performs a lookup operation to locate and automatically read the ContentEngine\config\log4j.properties file.

Performance Considerations

The logging level you specify determines the amount of information that is collected. A direct correlation exists between the amount of information collected and the performance impact on the system.

If possible, try to determine how much information you'll need to resolve the problem you are investigating, then set the level accordingly. As an example, setting the WARN level provides sufficient info for debugging but does not include much detail. There is a minor performance impact (approximately 1 to 2 per cent). You can safely run the WARN level in a production environment, but you might not get all the data you require.

On the other hand, running the DEBUG level only for RemoteCommand provides additional detail but can degrade performance by 10 to 20 per cent. In contrast, if you run the DEBUG level for all Content Engine API activity, you'll get the most detail but at the expense of system performance, which would probably be at a level unacceptable for a production environment. Much of the additional detail collected would most likely not be useful for a debugging effort and the collection of it would severely impact system performance. In a production environment, you should run DEBUG level only when necessary and then only for short periods of time.

Another consideration is the output method you choose. For example, the console is always available. Redirecting console output to a file does not degrade performance to any great extent. However, writing output to a console using a console program can be much more expensive than writing to a file. (Some console programs store ever-growing memory buffers and repaint the window multiple times for every log line.) File output has some disadvantages as well. For example, the log directory must exist and be writable. A good rule of thumb is to minimize console logging in a production environment, and log anything important to a file to ensure the information is not lost.

For more information, refer to the performance related topics in the Apache log4j documentation.

Common Problems

The table below describes some common problems you might encounter when configuring and running log4j. Where applicable, we include suggestions for how to resolve them or references to relevant documentation.

Problem	Common Causes	Resolution
Log file for `FileAppender` cannot be created.	The directory in which you want to create the log file does not exist. Permissions are insufficient to allow file creation.	Make sure that the directory in which you want to create the log file exists. If the directory exists, check the permissions and make sure that they are sufficient to allow the creation of the log file.
Your output does not reflect the settings specified in the ContentEngine\config\log4j.properties file.	The ContentEngine\config\log4j.properties file is not in the run time classpath. The ContentEngine\config\log4j.properties file is being overridden by another log4j.properties file that is also in the classpath.	Make sure that you add the ContentEngine\config\log4j.properties file to the run time classpath. If you suspect the file is being overridden by another configuration file, consider explicitly loading and setting the configuration.
Entries are being logged multiple times to the same location.	Configuration error.	See the Apache log4j documentation.
Entries are not logged for the Content Engine Java API, but are logged for the Content Engine client application.	The JVM supports only one log4j.properties configuration file, and you have two log4j.properties files, one for the Content Engine Java API and one for the Content Engine client.	Combine the logging directives from the Content Engine Java API and the Content Engine client into one log4j.properties file. See "How to Enable Client-Side Content Engine Java API logging on Content Engine Clients" below.

How to Enable Client-Side Content Engine Java API logging on Content Engine Clients

A JVM supports only one log4j.properties. The Content Engine Java API implements log4j logging and includes a log4j.properties configuration file. If your Content Engine client application also implements log4j logging, then you must combine the logging directives from the Content Engine Java API and the Content Engine client into one log4j.properties file.

The following table lists three Content Engine client applications, two IBM® FileNet applications and a custom application. Also listed are the default directories for the log4j.properties configuration files, for the applications and for the Content Engine Java APIs included with the applications. For each application, you would copy logging directives from the Content Engine Java API's log4j.properties into the Content Engine client's log4j.properties. You would perform the same actions with other Content Engine client applications that implement log4j logging, such as the Process Engine.

CE Client Application	Default Directory of Client's log4j.properties	Default Directory of CE Java API log4j.properties
Workplace	<install path>/FileNet/Config/AE	<install path>/FileNet/AE/CE_API/config/samples
Workplace XT	<install path>/FileNet/Config/WebClient	<install path>/FileNet/CEClient/config/samples
Custom application	<install path>/FileNet/Config/WebClient	<install path>

Add the following lines from the CE Java API's log4j.properties to the CE client's log4j.properties. For different levels of trace logging, review the comments and uncomment or comment out the appropriate lines. After merging the log4j.properties files, restart the client application for the changes take effect.

################################################################################
# Appenders
################################################################################

#=== FileNetConsoleAppender
log4j.appender.FileNetConsoleAppender=org.apache.log4j.ConsoleAppender
log4j.appender.FileNetConsoleAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetConsoleAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetErrorRollingAppender
log4j.appender.FileNetErrorRollingAppender=org.apache.log4j.RollingFileAppender
log4j.appender.FileNetErrorRollingAppender.File=/p8_api_error.log
log4j.appender.FileNetErrorRollingAppender.MaxFileSize=100MB
log4j.appender.FileNetErrorRollingAppender.MaxBackupIndex=5
log4j.appender.FileNetErrorRollingAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetErrorRollingAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetTraceRollingAppender
log4j.appender.FileNetTraceRollingAppender=org.apache.log4j.RollingFileAppender
log4j.appender.FileNetTraceRollingAppender.File=/p8_api_trace.log
log4j.appender.FileNetTraceRollingAppender.MaxFileSize=100MB
log4j.appender.FileNetTraceRollingAppender.MaxBackupIndex=5
log4j.appender.FileNetTraceRollingAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.FileNetTraceRollingAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n


################################################################################
# Error Loggers:
#
# Set log level to either one of off/fatal/error/warn/info.
# Child logger's value overwrites parent logger's value.
# If a logger is not specified, it inherents its value from its parent.
# By default, error logging is set to level ERROR.
################################################################################
# Don't comment out the following line since it has appenders.
log4j.logger.filenet_error = error, FileNetConsoleAppender, FileNetErrorRollingAppender, FileNetTraceRollingAppender

#=== SubSystem: api
# Uncomment to set error logging level to WARN.
log4j.logger.filenet_error.api = warn
log4j.logger.filenet_error.error = warn

################################################################################
# Trace loggers:
#
# Setting log level to "off" will turn off trace logging.
# Setting log level to "debug" will turn on trace logging.
#
# Child logger's value overwrites parent logger's value.
# If a logger is not specified, it inherents its value from its parent.
# By default, trace logging is off.
#
# The general message trace logging has a hierarchy of three detail levels represented with
# hierarchical logger names:
# ...detail.moderate.summary -- Enables a summary level of tracing
# ...detail.moderate -- Enables a summary and moderate level of tracing
# ...detail -- Enables a summary, moderate and detailed level of tracing
#
# Uncomment corresponding lines to turn tracing on. To enable trace logging
# for all subsystems and all flags, set the level of the filenet_tracing
# logger to debug.
#
# Here are the trace flags used for each sub system. For message tracing, enable the line
# corresponding to the desired detail level.
# log4j.logger.filenet_tracing.<SubSystem>.timer = debug
# log4j.logger.filenet_tracing.<SubSystem>.detail.moderate.summary = debug
# log4j.logger.filenet_tracing.<SubSystem>.detail.moderate = debug
# log4j.logger.filenet_tracing.<SubSystem>.detail = debug
#
# For example:
# log4j.logger.filenet_tracing.api.detail.moderate = debug
################################################################################
# Don't comment out the following line since it includes an appender.
log4j.logger.filenet_tracing = off, FileNetTraceRollingAppender

#=== SubSystem: api
# Uncomment one or more lines to enable tracing.
#log4j.logger.filenet_tracing.api = debug
#log4j.logger.filenet_tracing.api.timer = debug
#log4j.logger.filenet_tracing.api.detail.moderate.summary = debug
#log4j.logger.filenet_tracing.api.detail.moderate = debug
#log4j.logger.filenet_tracing.api.detail = debug
# Uncomment the line below to enable error tracing.
log4j.logger.filenet_tracing.error = debug