About the Studio log files

About the main Studio log file

In the Studio log file configuration, the main root logger prints all messages to:

The console, which typically is redirected to the application server's output log (For Tomcat, catalina.out and for WAS, SystemOut.log)
A file called eid-studio.log

The main logger does not print messages from the com.endeca.portal.instrumentation classes. Those messages are printed to the metrics log file.

Location of eid-studio.log

By default, the logger tries to create eid-studio.log in the following directory:

Tomcat:

The default location of eid-studio.log is:

<value of catalina.home>/logs

For example, if catalina.home is set to C:\endeca-portal\tomcat-6.0.29, then eid-studio.log is located in:

C:\endeca-portal\tomcat-6.0.29\logs

WAS 7:

The default location of eid-studio.log is either the value of SERVER_LOG_ROOT or the value of LOG_ROOT.

If SERVER_LOG_ROOT is defined, then the file is located in:
<value of SERVER_LOG_ROOT>

SERVER_LOG_ROOT might be set to something like /usr/local/WAS/AppServer/profiles/AppSrv01/logs/server1
If SERVER_LOG_ROOT is not defined, then the file is located in:
<value of LOG_ROOT>

LOG_ROOT might be set to something like /usr/local/WAS/AppServer/profiles/AppSrv01/logs

WebLogic 11g:

The default location of eid-studio.log is the root directory of the WebLogic domain.

If the logger can't place the file in the default directory, then you typically can find eid-studio.log in one of the following locations:

Tomcat - startup script:	If you started Tomcat by running a startup script, the log file is located where the script was run. For example, if you ran the startup script from tomcat-<version>/bin, the log file also is in tomcat-<version>/bin.
Tomcat - Windows service:	If you registered and started Tomcat as a Windows service, the log file may be in C:\Windows\System32 or C:\Windows\SysWOW64.
Tomcat - Eclipse server:	If Tomcat is a server inside of Eclipse, the log files may be located in the root of the Eclipse directory.
WAS 7:	For WAS 7, the log file is located relative to the profile's working directory. For example, /usr/local/WAS/AppServer/profiles/AppSrv01.
WebLogic 11g:	Does not apply. The log file is always in the domain directory.

Specifying an absolute path to the log file

The custom appender used for Studio logging contains the logic for determining the log file directory.

<appender name="FILE" class="com.endeca.portal.util.ContainerAwareRollingFileAppender">
	<param name="File" value="eid-studio.log"/>
	<param name="MaxFileSize" value="10MB"/>
	<param name="MaxBackupIndex" value="10"/>
	<layout class="org.apache.log4j.PatternLayout">
		<param name="ConversionPattern" value="%d{ISO8601} %-5p [%c{1}] %m%n" />
</layout>
</appender>

If you want to specify an absolute file path for the log files, then you will need to update the appender configuration to use the regular log4j appender class.

In portal-log4j-ext.xml, make the following changes to the appender configuration:

Change the class to be org.apache.log4j.RollingFileAppender.
Change the value of the File parameter to specify the full path to the file.

For example:

<appender name="FILE" class="org.apache.log4j.RollingFileAppender">
	<param name="File" value="C:\endeca-portal\logs\eid-studio.log"/>
	<param name="MaxFileSize" value="10MB"/>
	<param name="MaxBackupIndex" value="10"/>
	<layout class="org.apache.log4j.PatternLayout">
		<param name="ConversionPattern" value="%d{ISO8601} %-5p [%c{1}] %m%n" />
</layout>
</appender>

About metrics logging

An additional file appender captures metrics logging, including all log entries from the com.endeca.portal.instrumentation classes.

The metrics log file, eid-studio-metrics.log, is in the same directory as eid-studio.log.

You also can view metrics data on the Performance Metrics page. For details on metrics logging, see Monitoring the Performance of Queries.