Using logs

 


+ Search Tips   |   Advanced Search

 


  1. Using WebSphere Portal log files
  2. Using WAS tracing and log files
  3. Using Member Manager tracing
  4. Next steps

 

Using WebSphere Portal log files

WebSphere Portal has log files that are created during installation and run time. This section describes the content of the log files and recommendations for when to check the log files.

 

Installation log files

The installation log files are in the directory <wp_root>/log, where wp_root is the directory where WebSphere Portal is installed. The table lists each file, describes the file content and recommends when to check the file for information that might assist in troubleshooting installation problems.

Log file name Contains Problem symptoms
wpinstalllog.txt Trace information that is generated by the installation program. Check this log if the WebSphere Portal installation stops before successful completion.

installmessages.txt

Messages that are generated during installation. The messages in this file are translated for the language that is specified during installation. Check this log for errors generated during installation.
wpcpInstallLog.txt Trace information generated by the WebSphere Portal content publishing component during installation. Check this log for errors related to the WebSphere Portal content publishing component.
wpsinstalllog.txt Trace information generated by the WebSphere Portal component during installation. Check this log for errors related to the WebSphere Portal component.
portletinstall.txt Messages generated during portlet installation. Check this log if problems occur with portlets being deployed during installation.
wpwasfp1.txt Trace information generated during the installation of WAS Fix Pack 1. Check this log if you have problems with the installation of WAS Fix Pack 1.
wppmefp1.txt Trace information generated during the installation of WAS Enterprise Edition Fix Pack 1. Check this log if you have problems with the installation of WAS Enterprise Edition Fix Pack 1.
log.txt Trace information generated during the installation of WAS.

Located in <was_root>/logs directory

Check this log if you have problems with the installation of WAS.
WAS.PME.install.log Trace information generated during the installation of WAS Enterprise Edition.

Located in <was_root>/logs directory

Check this log if you have problems with the installation of WAS Enterprise Edition.

 

The following log files are located in the <temp> directory and are used during installation. You can access the <temp> by typing %temp% into the address field in the Explorer window. Note that the wpinstalllog.txt and wpsinstalllog.txt log files that are previously described begin in the <temp> directory and are moved to <wp_root>/log early in the installation.

Note for Windows users: The <temp> directory is typically located in a hidden directory named Documents and Settings\<user>\Local Settings. For example, C:\Documents and Settings\Administrator\Local Settings\Temp. You might need to set your folder options appropriately in order to view hidden files and directories.

Log file name Description Problem symptoms
installtraces1.txt
installtraces2.txt
installtraces3.txt
Contain trace information generated by the dependency checking function. Output is added to installtraces1.txt until it reaches a predefined size, at which point output goes into installtraces2.txt and then into installtraces3.txt. When installtraces3.txt is full, output reverts to installtraces1.txt and overwrites previous trace information. Check these files if there are problems with component discovery and dependency checking.

 


Run-time log files

The run-time log files are:

 

WebSphere Portal run-time log file

The WebSphere Portal log file contains messages and trace information, if tracing is enabled. The default run-time log file is:

<wp_root>/log/wps_<date_time>.log

where <wp_root> is the WebSphere Portal root directory and <date_time> is the date and time the file was created.

Messages and trace information are contained in the same log file. Message logging is always enabled. Trace logging is enabled by setting properties in...

<wp_root>/shared/app/config/log.properties

The default setting is that trace logging is disabled. Settings in this file are applied whenever WebSphere Portal is running. However, if you want to set logging options for the current session only, use the Enable Tracing page in the WebSphere Portal Administration pages.

Refer to the topic System event logging, in the Administering your portal section, for details on how to configure logging and for more information on the grammar of the "trace string" configuration key.

The following table describes trace loggers for particular situations and problem symptoms. Enabling the trace loggers can slow down WebSphere Portal.

Component When to use Trace string Additional comments
AccessControl Enable this tracer if you want permissions for resources to be explained in detail, need to verify the correctness of a permission, or need to isolate a defect in access control. com.ibm.wps.ac.*=all=enabled The traces are easier to evaluate while WebSphere Portal usage is low.
Authentication   com.ibm.wps.engine.commands.*=all=enabled:
com.ibm.wps.services.puma.*=all=enabled:
com.ibm.wps.puma.*=all=enabled:
com.ibm.wps.engine.servlet=all=enabled:
com.ibm.wps.sso.*=all=enabled
 
Command Use to turn on all command trace loggers. com.ibm.wps.commands.*=all=enabled  
Composition Enable these messages if you want to get more information on how pages are constructed, need to verify page lists displayed on WebSphere Portal for correctness, or need to isolate an error in the WebSphere Portal aggregation component. com.ibm.wps.composition.*=all=enabled The traces are easier to evaluate while WebSphere Portal usage is low.
CredentialVault   com.ibm.wps.sso.*=all=enabled:
com.ibm.wps.command.credentialvault.*=all=enabled:
com.ibm.wps.portletservice.credentialvault.*=all=enabled
 
Database Deals with generated SQL statements and the internal flow in the WebSphere Portal database layer. com.ibm.wps.datastore.*=all=enabled:
com.ibm.wps.services.datastore.*=all=enabled
Important: Enabling this logger will create very large log files.
EngineCommands Use to diagnose problems with logging in, enrollment, and WebSphere Portal navigation. com.ibm.wps.engine.commands.*=all=enabled  
Engine Use to enable all engine trace loggers. com.ibm.wps.engine.*=all=enabled  
EngineTags Use to diagnose problems with tags within Java Server Pages. com.ibm.wps.engine.tags.*=all=enabled  
EngineTemplates Use to diagnose problems with internationalization and selecting device-dependent templates. com.ibm.wps.engine.templates.*=all=enabled  
FrameworkObjectModel   com.ibm.wps.model.impl.*=all=enabled:
com.ibm.wps.composition.Composition=all=enabled:
com.ibm.wps.composition.CompositionMap=all=enabled:
com.ibm.wps.model.invalidation.*=all=enabled:
com.ibm.wps.model.factory.*=all=enabled
Enables tracing for all portlets. Therefore, place the suspect portlet on a separate page for testing.
General   com.ibm.wps.*=all=enabled

If you want to use general tracing but do not want render times to be displayed for such portlets, selectively disable tracing using the following trace string:

com.ibm.wps.pe.PortletRenderTimeLoggingHelper=all=disabled

When general tracing is enabled and parallel portlet rendering is turned on, portlets that are configured to be rendered in parallel will display the render time as part of the portlet content.
LoggingIn   com.ibm.wps.puma.*=all=enabled:
com.ibm.wps.services.puma.*=all=enabled:
com.ibm.wps.engine.commands.*=all=enabled:
com.ibm.wps.sso.*=all=enabled
The previous values have to be set in the log.properties file as one line without blanks or line feeds between the sections.
MappingURLs Use to diagnose problems with the user-defined mappings of URLs com.ibm.wps.mappingurl.*=all=enabled:
com.ibm.wps.command.mappingurl.*=all=enabled
 
ModelFactory   com.ibm.wps.model.factory.*=all=enabled  
ModelInvalidation   com.ibm.wps.model.invalidation.*=all=enabled  
Model   com.ibm.wps.model.impl.*=all=enabled:
com.ibm.wps.composition.Composition=all=enabled:
com.ibm.wps.composition.CompositionMap=all=enabled
 
PageAggregation   com.ibm.wps.composition.*=all=enabled:
com.ibm.wps.services.navigator.*=all=enabled
 
PortletContainer   com.ibm.wps.pe.pc.*=all=enabled:
org.apache.jetspeed.portlet.Portlet=all=enabled
 
PortletEnvironment   com.ibm.wps.pe.ext.*=all=enabled:
com.ibm.wps.pe.factory.*=all=enabled:
com.ibm.wps.pe.om.*=all=enabled:
com.ibm.wps.pe.util.*=all=enabled
 
PortletManager   com.ibm.wps.pe.mgr.*=all=enabled:
com.ibm.wps.services.deployment.*=all=enabled:
com.ibm.wps.command.applications.*=all=enabled:
com.ibm.wps.command.portlets.*=all=enabled
 
Portlets Use to diagnose problems with portlets. com.ibm.wps.portlets.*=all=enabled:
org.apache.jetspeed.portlet.PortletLog=all=enabled
Enables tracing for all portlets. Therefore, place the suspect portlet on a separate page for testing.
Registration Use to diagnose problems with user registration and profile editing. com.ibm.wps.services.puma.*=all=enabled:
com.ibm.wps.puma.*=all=enabled
Use this logger if there are errors in self-registration, self-care, and the Manage Users and Groups portlet.
ServicesDataStore Logs the transaction handling of the WebSphere Portal datastore service. com.ibm.wps.services.datastore.*=all=enabled Important: Enabling this logger will create very large log files.
ServicesDispatcher Use for observing the calling of JSPs. com.ibm.wps.services.dispatcher.*=all=enabled  
ServicesEventBroker   com.ibm.wps.services.registry.EventHandlerRegistry=all=enabled:
com.ibm.wps.services.events.*=all=enabled
 
ServicesFinder Use for debugging the resolution of file names. com.ibm.wps.services.finder.*=all=enabled  
ServicesLoader Use to trace the dynamic class loading performed by this service. com.ibm.wps.services.ServiceManager=all=enabled  
ServicesLocalizer Logs the WebSphere Portal default locale during initialization. com.ibm.wps.services.localizer.*=all=enabled  
ServicesNaming Use to debug the lookup of objects by the naming service. com.ibm.wps.services.naming.*=all=enabled  
ServicesNavigator Use to diagnose problems with parts of page aggregation and display. com.ibm.wps.services.navigator.*=all=enabled  
ServicesRegistry Use to view the policies of the internal portlet object caching and watch it reload its content. com.ibm.wps.services.registry.*=all=enabled  
Services Use for switching on tracing for all services. com.ibm.wps.services.*=all=enabled  
SiteAnalyzer Use to trace problems with logging site analysis logging data for the portal. com.ibm.wps.services.siteanalyzer.*=all=enabled  
SSOCredentialVault   com.ibm.wps.sso.credentialvault..*=all=enabled  
SSO Use to turn on all SSO tracer loggers listed after this trace logger. com.ibm.wps.sso.*=all=enabled Use this logger if errors occur when use the Security Vault task on the Security page of the Portal Administration pages.
SSOVaultService   com.ibm.wps.sso.vaultservice.*=all=enabled  
UserManagement Use to trace problems with the user subsystem, such as problems with logging in, enrollment, and access control. com.ibm.wps.services.puma.*=all=enabled:
com.ibm.wps.puma.*=all=enabled:
com.ibm.wps.command.puma.*=all=enabled
 
XMLAccess Use to diagnose problems with the XML import/export of WebSphere Portal configurations. com.ibm.wps.command.xml.*=all=enabled  

 

Site analysis log file

For instructions on setting the site analysis loggers, see the Site analysis topic.

 

Using WAS tracing and log files

WAS has log files and a tracing function. These logs are not useful for troubleshooting WebSphere Portal problems. Instead, use the ConfigureAppServer.log and StartWPS.log files to determine whether WAS was successfully configured for the WebSphere Portal and whether WebSphere Portal was successfully started on WAS. Both log files are described in Installation log files.

 

Using Member Manager tracing

Member Manager uses the Application Servers trace facilities to create trace information. If you need detailed trace output of Member Manager to debug a problem, follow these steps:

  1. Start WAS.
  2. Open the Administrative Console.
  3. Go to section Troubleshooting Then click Logs and Traces Then click WebSphere_Portal Then click Diagnostic Trace.
  4. Make sure that the check box Enable Trace is selected.
  5. Enter in the TraceSpecification field:

    com.ibm.websphere.wmm.*=all=enabled:com.ibm.ws.wmm.*=all=enabled:WSMM=all=enabled
  6. Save the changes.
  7. Restart WebSphere Portal.

The resulting traces of Member Manager will be written to <wp_root>/log/trace.log.

 

Next steps

You have completed this step. Continue to the next step by choosing one of the following topics:

 

See also

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.