About logging in Studio

Studio uses the Apache Log4j logging utility.

The Studio log files include:
  • A main log file with most of the logging messages
  • A second log file for performance metrics logging
  • A third log file for client-side logging, in particular JavaScript errors

The log files are generated in both the standard Log4j format, and the ODL (Oracle Diagnostic Logging) format. The log rotation frequency is set to daily (it is hard-coded, not configurable).

You can also use the Performance Metrics page of the Control Panel to view performance metrics information.

For more information about Log4j, see the Apache log4j site, which provides general information about and documentation for Log4j.

ODL log entry format

The following is an example of an ODL-format NOTIFICATION message resulting from creation of a user session in Studio: 
[2015-08-04T09:39:49.661-04:00] [EndecaStudio] [NOTIFICATION] [] 
   [com.endeca.portal.session.UserSession] [host: web12.example.com] [nwaddr: 10.152.105.219] 
   [tid: [ACTIVE].ExecuteThread: '45' for queue: 'weblogic.kernel.Default (self-tuning)'] 
   [userId: djones] [ecid: 0000Kvsw8S17ADkpSw4Eyc1LjsrN0000^6,0] UserSession created
The format of the ODL log entries (using the above example) and their descriptions are as follows:
ODL log entry field Description Example
Timestamp The date and time when the message was generated. This reflects the local time zone. [2015-08-04T09:39:49.661-04:00]
Component ID The ID of the component that originated the message. "EndecaStudio" is hard-coded for the Studio component. [EndecaStudio]
Message Type The type of message (log level):
  • INCIDENT_ERROR
  • ERROR
  • WARNING
  • NOTIFICATION
  • TRACE
  • UNKNOWN
 [NOTIFICATION]
Message ID The message ID that uniquely identifies the message within the component. The ID may be null. []
Module ID The Java class that prints the message entry. [com.endeca.portal.session.UserSession]
Host name The name of the host where the message originated. [host: web12.example.com]
Host address The network address of the host where the message originated [nwaddr: 10.152.105.219]
Thread ID The ID of the thread that generated the message. [tid: [ACTIVE].ExecuteThread: '45' for queue: 'weblogic.kernel.Default (self-tuning)']
User ID The name of the user whose execution context generated the message. [userId: djones]
ECID The Execution Context ID (ECID), which is a global unique identifier of the execution of a particular request in which the originating component participates. Note that [ecid: 0000Kvsw8S17ADkpSw4Eyc1LjsrN0000^6,0]
Message Text The text of the log message. UserSession created

Log4j log entry format

The following is an example of a Log4j-format INFO message resulting from creation of a user session in Studio: 
2015-08-05T05:42:09.855-04:00 INFO [UserSession] UserSession created
The format of the Log4j log entries (using the above example) and their descriptions are as follows:
Log4j log entry field Description Example
Timestamp The date and time when the message was generated. This reflects the local time zone. [2015-08-04T09:39:49.661-04:00]
Message Type The type of message (log level):
  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG
 [INFO]
Module ID The Java class that prints the message entry. [UserSession]
Message Text The text of the log message. UserSession created