Logging

The Portal Server logging API is an implementation of the JSR 47: Logging API Specification. Each Portal Server application has its own configuration file. Portal administrators can do the following:

• Associate a configuration file with its corresponding application

• Make specific configuration changes that affect only that application

• Achieve easier cleanup of applications

By default, the log file directory is /var/opt/sun/portal/portals/portal1/logs/portal-server-instance. The com.sun.portal.log.config.file properties file provides the default configuration of the logging system. You can specify the location and names of the portal log files specified in this file.

Administrators can define the following logging attributes:

• Maximum size of the log file

• Number of history files

• Type of log level

If a portal administrator uses a tool to view web container logs, the Portal Server logging framework enables the administrator to use the tool to view portal logs as well.

Application Log Configuration Files

Each Portal Server application has at least one log configuration file associated with it. This topic lists file names for the following applications:

• Portal Instance

• Portlet Applications

• Search Application

• Administrative CLIs

• Portal Administration Server

• Management Console

• Gateway

• Netlet Proxy

• Rewriter Proxy

Portal Instance

The log configuration file name is:

• portal_server_data_directory/portals/portal_ID/config/PSLogConfig.properties

  Example: /var/opt/SUNWportal/portals/myPortal/config/PSLogConfig.properties

The log file location is:

• portal_server_data_directory/portals/portal_ID/logs/instance_ID

  Example: /var/opt/SUNWportal/portals/myPortal/logs/myInstance/

By default, one file is created. The file name is portal.0.0.log.

Portlet Applications

The log configuration file name is:

• portal_server_data_directory/config/portal_ID/config/PSLogConfig.properties

  Example: /var/opt/SUNWportal/portals/myPortal/config/PSLogConfig.properties

The log file location is:

• portal_server_data_directory/portals/portal_ID/logs/instance_ID

  Example: /var/opt/SUNWportal/portals/myPortal/logs/myInstance/

By default, one file is created. The file name is portal.0.0.log. The content is logged through PortletContext.log().

Search Application

The log configuration file name is:

• portal_server_data_directory/searchserver/search_ID/config/SearchLogConfig.properties

  Example: /var/opt/SUNWportal/searchserver/mySearch/config/SearchLogConfig.properties

The log file location is:

• portal_server_data_directory/searchserver/search_ID/logs/

  Example: /var/opt/SUNWportal/searchserver/mySearch/logs/

By default, three files are created. The file names are:

• rdmserver.0.0.log

• rdm.0.0.log

• rdmgr.0.0.log

Administrative CLIs

The log configuration file name is:

• portal_server_configuration_directory/PSAdminLogConfig.properties

  Example: /etc/opt/SUNWportal/PSAdminLogConfig.properties

The log file location is:

• portal_server_data_directory/logs/admin/

  Example: /var/opt/SUNWportal/logs/admin/

By default, one file is created. The file name is portal.admin.cli.0.0.log.

Portal Administration Server

The log configuration file name is:

• portal_server_configuration_directory/PSAdminLogConfig.properties

  Example: /etc/opt/SUNWportal/PSAdminLogConfig.properties

The log file location is:

• portal_server_data_directory/logs/admin/

  Example: /var/opt/SUNWportal/logs/admin/

By default, one file is created. The file name is portal.0.0.log.

Management Console

The log configuration file name is:

• portal_server_data_directoryportals/portal_ID/config/PSLogConfig.properties

  Example: /var/opt/SUNWportal/portals/myPortal/config/PSLogConfig.properties

The log file location is:

• portal_server_data_directory/logs/admin/

  Example: /var/opt/SUNWportal/logs/admin/

By default, one file is created. The file name is portal.admin.console.0.0.log.

Gateway

The log configuration file name is:

• portal_server_configuration_directory/platform.conf.profile

  Example: /etc/opt/SUNWportal/platform.conf.default

The log file location is:

• portal_server_data_directory/logs/sra/profile/

  Example: /var/opt/SUNWportal/logs/sra/default/

By default, one file is created. The file name is portal.gateway.0.0.log.

Netlet Proxy

The log configuration file name is:

• portal_server_configuration_directory/platform.conf.profile

  Example: /etc/opt/SUNWportal/platform.conf.default

The log file location is:

• portal_server_data_directory/logs/sra/profile/

  Example: /var/opt/SUNWportal/logs/sra/default/

By default, one file is created. The file name is portal.nlproxy.0.0.log.

Rewriter Proxy

The log configuration file name is:

• portal_server_configuration_directory/platform.conf.profile

  Example: /etc/opt/SUNWportal/platform.conf.default

The log file location is:

• portal_server_data_directory/logs/sra/profile/

  Example: /var/opt/SUNWportal/logs/sra/default/

By default, one file is created. The file name is portal.rwproxy.0.0.log.

To Manage Portal Server Logging

1. Log in to the Portal Server management console.

   The Common Tasks page is displayed.

2. Click the Portals tab.

   The Portals page is displayed.

3. Click the name of the portal that you want to examine.

   The Desktop Tasks and Attributes page is displayed.

4. Click the Logging tab.

   The Log Viewer page is displayed.

5. From the Instance Name scrollbar, select a portal instance.

   The logging options are displayed.

6. Set the search criteria, and click Search.

   The information is displayed in the Search Results section.

   For more information, click the Help button to view online help.

To Manage Search Server Logging

1. Log in to the Portal Server management console.

   The Common Task page is displayed.

2. Click the Search Servers tab.

   The Search Servers page is displayed.

3. Click the name of the search server that you want to examine.

   The Search Server Settings page is displayed.

4. Click the Reports tab.

   The Log Files page is displayed.

5. Select the reports that you want.

   • To view log file contents, click the Logs tab.

   • To view robot report files, click the Advanced Robot Reports tab.

   • To view information about end-user searches, click the Manage Popular Searches tab.

   • To view information about URLs that were excluded during a robot run, click the Manage Excluded URLs button.

   For more information, click the Help button to view online help.