Configures and enables trace logging on the Content Engine host for the supported subsystems. Each of the supported subsystems is a property on this class, enabling trace logging to be configured per subsystem. Configuring trace logging for a subsystem applies the trace logging settings to all classes in that subsystem. The TraceFlag constant class contains the trace log settings available. These settings can be ORed together to apply multiple settings to a subsystem. The TraceLoggingEnabled property on this (TraceLoggingConfiguration) class enables or disables trace logging for all of the configured subsystems. Use the AppenderNames property to specify the output destination classes for the trace logs.

Trace logging is implemented using the Apache log4j package (org.apache.log4j).


The following tables list the members exposed by ITraceLoggingConfiguration.

Public Properties

 NameDescription
Public propertyAPITraceFlagsSpecifies the trace flags applied to the classes in the API subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyAppenderNamesOne or more log4j class names identifying the output destinations to use for the trace logging data. Multiple appender names are separated by commas. It is expected that the use of multiple names will be to specify a console appender and a file appender. If the class names are specified using package prefixes, the class names are interpreted absolutely; otherwise, the class names are prefixed with "org.apache.log4j" during processing. Validation of appender names occurs when they are persisted, rather than when logging is configured.

If no appender name is specified, RollingFileAppender is used by default. In this way, you need only enable the TraceLoggingEnabled property and set the appropriate fields in TraceFlags to initiate useful trace logging.

Note: The error log "filenet_error" (the default) is updated to reference the configured appenders. If the base error log file is not "filenet_error", error log messages are not written to the trace logs.

The supported output destinations (class names) are as follows:

  • ConsoleAppender - Sends trace logging data to the default console.
  • FileAppender - Sends trace logging data to the location specified in the OutputLocation property.
  • DailyRollingFileAppender - A subclass of FileAppender. Backs up (rolls over) the trace logs located in the directory referenced by the OutputLocation property on a scheduled basis. The log4j DatePattern is "yyyy-MM-dd", which initiates the backup operation daily at midnight.
  • RollingFileAppender - A subclass of FileAppender. The default appender used if none is specified. Backs up the trace logs located in the directory referenced by the OutputLocation property when the files exceed the maximum size.

    The default maximum trace log file size is 100MB, and the default backup index file size is 5MB. You can override these default values using the log4j command line properties "MaxRollingFileSize" and "MaxRollingFileBackups".

For more information, see org.apache.log4j.FileAppender.

Public propertyAsynchronousProcessingTraceFlagsSpecifies the trace flags applied to the classes in the Asynchronous Processing subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyCBRTraceFlagsSpecifies the trace flags applied to the classes in the CBR (Content-Based Retrieval) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyCFSDaemonTraceFlagsSpecifies the trace flags applied to the classes in the CFS Daemon (Content Federation System) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyCFSImportAgentTraceFlagsTrace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.
Public propertyCodeModuleTraceFlagsSpecifies the trace flags applied to the classes in the Code Module subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyContentCacheTraceFlagsSpecifies the trace flags applied to the classes in the Content Cache subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyContentStorageTraceFlagsSpecifies the trace flags applied to the classes in the Content Storage subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyDatabaseTraceFlagsSpecifies the trace flags applied to the classes in the Database subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyEJBTraceFlagsSpecifies the trace flags applied to the classes in the EJB subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyEngineTraceFlagsSpecifies the trace flags applied to the classes in the Engine subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyErrorTraceFlagsTrace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.
Public propertyEventsTraceFlagsSpecifies the trace flags applied to the classes in the Events subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyFixedContentProviderTraceFlagsSpecifies the trace flags applied to the classes in the Fixed Content Provider subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyGCDTraceFlagsSpecifies the trace flags applied to the classes in the GCD (Global Configuration Data) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyMetadataTraceFlagsSpecifies the trace flags applied to the classes in the Metadata subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyOutputLocationThe fully qualified path to use as the output location for trace logs (used only when the AppenderName property value is the FileAppender class or a subclass. If unspecified or null, this property value defaults to the application server instance's working directory path appended with "/FileNet". The filename for the trace log is always "p8_server_trace.log", and the log4j layout pattern used is "%d %5p [%t] - %m%n".

Note: Because log4j creates directories on the fly, the only validation against a non-null value for this property is that the location resides within a valid directory.

Public propertyPublishTraceFlagsSpecifies the trace flags applied to the classes in the Publish subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyReplicationTraceFlagsThis property is not supported.
Public propertySearchTraceFlagsSpecifies the trace flags applied to the classes in the Search subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertySecurityTraceFlagsSpecifies the trace flags applied to the classes in the Security subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertySSITraceFlagsSpecifies the trace flags applied to the classes in the SSI (Single-document Storage Interface) subsystem, an interface between the Content Engine and FileNet Image Services. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyTraceLoggingEnabledIndicates whether trace logging is currently enabled for all configured subsystems.
Public propertyWSITraceFlagsSpecifies the trace flags applied to the classes in the Web Services subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Top

See Also