The commons-logging.properties file is used to specify the WebCenter Sites logging system via the org.apache.commons.logging.Log property. Newly installed WebCenter Sites systems use Apache log4j, which is specified as follows:
org.apache.commons.logging.Log=com.fatwire.cs.core.logging.Log4JLogger
More information about Apache log4j is available in Chapter 12, "log4j.properties."
A large variety of other loggers are available in the public domain. You can also write your own loggers if the features sought are not present in any available loggers. If you choose to use Commons Logging with loggers other than log4j, you can still use the Property Editor to view and change log settings.
If the need arises to switch back to the previous Content Server 7.6 Commons Logging system, you will have to manually set org.apache.commons.logging.Log to one of the class names listed below:
TraditionalLog
com.fatwire.cs.core.logging.TraditionalLog
This logger writes all log messages to the WebCenter Sites log file for each server. TraditionalLog supports log file rolling, custom formatting, date-stamping, and a variety of other features. Optionally, TraditionalLog supports browser-based log retrieval by filtering log messages based on the client's IP address.
StandardLog
com.fatwire.cs.core.logging.StandardLog
This logger also supports custom formatting, date-stamping, and so on, but it sends messages to the standard output and standard error streams; in other words, it sends messages to the java console instead of the WebCenter Sites log file. While StandardLog does not support browser-based log retrieval, it offers another useful feature: It allows developers running a JumpStart Kit or running WebCenter Sites in an IDE debugger to see all of the log messages in the most obvious place. Using StandardLog is good practice for all template developers, because it alerts you to errors by default, as opposed to sending an error to the WebCenter Sites log file, where it requires some effort to be viewed. StandardLog is similar to Apache's default SimpleLog.
StandardTraditionalLog com.fatwire.cs.core.logging.StandardTraditionalLog
This logger supports the features and output methods of TraditionalLog and StandardLog.
The commons-logging.properties file lists the logging properties that can be modified for WebCenter Sites. The properties are organized by function on the following tabs in the Property Editor:
Table 5-2 Properties in commons-logging.properties: Factory Tab
| Property | Description |
|---|---|
|
Specifies the class name implementing the Default value: The default value names a WebCenter Sites enhanced logger that supports additional features not necessarily supported by other loggers, including browser-based retrieval of the log file, rolling logs, and timestamps. Note: Before modifying the value, consult the commons-logging documentation. |
|
|
Enables a special publishing logger that prints the This property must be manually added to Legal values Note: Enabling this logger automatically disables per-client logging (the value of the |
Table 5-3 Properties in commons-logging.properties: Loggers Tab
| Property | Description |
|---|---|
|
Specifies the log severity for the generic WebCenter Sites logger. Messages written to this logger relate to the core WebCenter Sites functionality, or they have not been assigned a more appropriate logger. Possible values: Default value: |
|
|
Specifies the log severity for user authentication and user authorization messages. Messages written to this logger relate to user login, user ACLs and user roles. Possible values: Default value: |
|
|
Specifies the log severity for BlobServer debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites page caches. Possible values: Default value: |
|
|
Specifies the log severity for page cache debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites page caches. Possible values: Default value: |
|
|
Specifies the log severity for resultset cache debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites resultset caches. Possible values: Default value: |
|
|
Logger used by the HttpAccess API to record errors and warnings encountered during HTTP access. This log produces HTTP Request and Response information, including headers, parameters, and body content. Possible values: Default value: |
|
|
Logger used by the URI assembler engine and all assemblers. Possible values: Default value: |
|
|
Logger used by URI definitions and related implementations. Possible values: Default value: |
|
|
Specifies the log severity for database access messages. Messages written to this logger relate to database access, queries and statement execution. It can be very helpful to use this logger to debug database queries that are not behaving as expected. Possible values: Default value: |
|
|
Logger used to display information related to setting an error number. Messages written by this logger relate to the values set for the Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites event engine messages. Messages written to this logger relate to the invocation of events by WebCenter Sites. Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites page export engine messages. Messages written to this logger relate to the invocation of events by WebCenter Sites. Possible values: Default value: |
|
|
Specifies the log severity for file locking messages. Possible values: Default value: |
|
|
Logger for FirstSite II filters. Possible values: Default value: |
|
|
Specifies the log severity for the WebCenter Sites installer's messages. Messages are only written to this log during installation. Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites Possible values: Default value: |
|
|
Logs operations that take place during the RealTime publishing process. Possible values: Default value: |
|
|
Specifies the log severity for request processing messages. Possible values: Default value: |
|
|
Generic logger for Satellite Server. Messages logged with this logger pertain to system configuration. Possible values: Default value: |
|
|
This logger for Satellite Server deals with information relating to the parsing of objects that can be cached, as well as their life cycle in the cache. Possible values: Default value: |
|
|
This logger for Satellite Server is dedicated to logging information that relates to communication between Satellite Server and its host WebCenter Sites. Possible values: Default value: |
|
|
This logger for Satellite Server is dedicated to logging information that relates to processing requests from the client. Possible values: Default value: |
|
|
Specifies the log severity for the WebCenter Sites session logger. Messages written to this logger relate to session creation, modification, and access. Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites cluster synchronization messages. Messages written to this logger relate to cluster sync behavior of WebCenter Sites. Possible values: Default value: |
|
|
Specifies the log severity for capturing system information on the WebCenter Sites installation. This logger is used by the System Tools utility, which is available on the Admin tab, in the WebCenter Sites administrator's interface. For more information about System Tools, see "System Tools" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide. Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites time and performance debug information. Messages written to this logger include information that can be used to tune the performance of pages and of WebCenter Sites in general. To log the execution time for pages and pagelets, set this property to
Note: Pages are executed only if they are not found in cache. Possible value: Default value: |
|
|
Logger for tracking the visitor object life cycle. Possible values: Default value: |
|
|
Logger for rule set compilation. Possible values: Default value: |
|
|
Logger for Xcelerate. Possible values: Default value: |
|
|
Logger for recommendation processing. Possible values: Default value: |
|
|
Logger for asset approval processing. Possible values: Default value: |
|
|
Logger for generic asset processing. Possible values: Default value: |
|
|
Logger for assetmaker processing. Possible values: Default value: |
|
|
This logger captures publishing logs. Possible values: Default value: Note: |
|
|
Logger for Template, CSElement, and SiteEntry asset processing. Possible values: Default value: |
|
|
Specifies the log severity for WebCenter Sites XML element debug information. Messages written to this logger relate to the parsing and evaluation of XML elements. It should be noted that enabling this debug flag will cause WebCenter Sites to use a validating XML parser instead of the default non-validating parser. This can have effects on rendered pages. Consult the documentation for details. Possible values: Default value: |
|
|
Logger used by asset-related search. Possible values: Default value: |
|
|
Top-level logger used by HttpComponents library. For more information, see Apache HttpComponents documentation. Possible values: Default value: |
|
|
This logger is used by the HttpComponents library for context logging. For more information, see Apache HttpComponents documentation. Possible values: Default value: |
|
|
This logger is used by the HttpComponents library for context logging. For more information, see the Apache HttpComponents documentation. Possible values: Default value: |
|
|
This logger is used by the HttpComponents library for connection management. For more information, see the Apache HttpComponents documentation. Possible values: Default value: |
|
|
This logger is used to log only the http headers. For more information, see the Apache HttpComponents documentation. Possible values: Default value: |
|
|
This logger is used to log all data transmitted to and from servers when executing HTTP requests. This logger should be enabled only for debugging, as it will produce an extremely large amount of log data, some of it in binary format. For more information, see the Apache HttpComponents documentation. Possible values: Default value: |
The table below lists properties that are specific to TraditionalLog, the default logger specified in the property org.apache.commons.logging.Log. TraditionalLog supports numerous features that other loggers might not support. In your Spark installation, you may choose to use a different logger with your own set of properties.
Table 5-4 Properties in commons-logging.properties: Traditional Log Tab
| Property | Description |
|---|---|
|
Specifies the full path to the log file. It is required and should be set to a different value for each VM to avoid conflicts. Note: This value must be specified or logging will fail. |
|
|
Specifies the |
|
|
Specifies the maximum size of the log file in bytes. Once the log file grows to the size specified, it will either be rolled or deleted. Set it to Default value: |
|
|
Specifies whether a log file will be kept for each distinct IP address that requests data from WebCenter Sites. This property allows the use of CatalogManager to retrieve the log file from a web browser. When this property is set to Possible values: Note: Per-client logging is automatically disabled if the |
|
|
Specifies how many logs will be kept when rolling the log file. Previous versions will be renamed and once all available versions are used, the oldest log will be deleted. Set to 0 to disable rolling of the log file. Set it to a positive integer to specify the number of logs to keep. Default value: |
|
|
Specifies whether or not the timestamp will be written to the log file for each logging entry. Possible values: Default value: |
By default, this tab contains the following properties:
Table 5-5 Properties in commons-logging.properties: User Defined Tab
| Property | Description |
|---|---|
|
This logger is used by the user interface model components. Possible values: Default value: |
|
|
This logger is used by DebugPhaseListener to display the phase of the JSF life cycle. Possible values: Default value: |
|
|
This logger is used by the user interface view components. The intended use of this logger is in debugging user interface components and their life cycle. Possible values: Default value: |
|
|
This logger is used by the Lucene integration. Possible values: Default value: |