test

Troubleshooting Sun Java System Portal Server Secure Remote Access 7

Log Files Location

The following table lists the location of all the log files and the various log file names associated with the Secure Remote Access components.

Table 3 Log Files Location

Component Name 

Log Configuration Filename and Location 

Log File Location 

Portal Instance 

<PS_DATA_DIR>/portals/ <PORTAL_ID>/config/ PSLogConfig.properties

For example /var/opt/SUNWportal/ portals/myPortal/ config/ PSLogConfig.properties

<PS_DATA_DIR>/portals/ <PORTAL_ID>/logs/<instance ID>.

For example, /var/opt/SUNWportal/portals /myPortal/logs/myInstance/

By default, only one file is created portal.0.0.log.

Portlet Applications 

<PS_DATA_DIR>/portals/ <PORTAL_ID>/config/ PSLogConfig.properties

For example, /var/opt/SUNWportal/portals/ myPortal/config/ PSLogConfig.properties.

<PS_DATA_DIR>/portals/ <PORTAL_ID>/logs/<instance ID>. For example, /var/opt/SUNWportal/portals/ myPortal/logs/myInstance/.

By default, only one file is created - portal.0.0.log. The content logged through PortletContext.log() gets appended to this file.

Search Webapp 

<PS_DATA_DIR>/searchserver/ <SEARCH_ID>/config/ SearchLogConfig.properties

For example, /var/opt/SUNWportal/ searchserver/mySearch/config/ SearchLogConfig.properties.

<PS_DATA_DIR>/searchserver/<SEARCH_ID>/ config/SearchLogConfig.properties.

By default, three files are created:rdmserver.0.0.log, rdm.0.0.log, rdmgr.0.0.log.

For example, /var/opt/SUNWportal/ searchserver/mySearch/logs/.

Administration CLIs 

<PS_CONFIG_DIR>/ PSAdminLogConfig.properties

For example, /etc/opt/SUNWportal/ PSAdminLogConfig.properties.

<PS_DATA_DIR>/logs/admin.

/var/opt/SUNWportal/logs/admin/.

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

Portal Administration Server 

<PS_CONFIG_DIR>/ PSAdminLogConfig.properties

For example, /etc/opt/SUNWportal/ PSAdminLogConfig.properties.

<PS_DATA_DIR>/logs/admin/. For example, /var/opt/SUNWportal/logs/admin/ .

By default, only one is created portal.0.0.log.

Administration Console 

<PS_DATA_DIR>/portals/ <PORTAL_ID>/config/ PSLogConfig.properties

For example, /var/opt/SUNWportal/portals/ myPortal/config/ PSLogConfig.properties.

<PS_DATA_DIR>/logs/admin/. For example, /var/opt/SUNWportal/logs/admin/ By default, only one file is created portal.admin.console.0.0.log.

Gateway 

<PS_CONFIG_DIR>/ platform.conf.<profile>

For example, /etc/opt/SUNWportal/ platform.conf.default .

PS_DATA_DIR>/logs/sra/<profile>/. For example, /var/opt/SUNWportal/logs/sra/default/.

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

Netlet proxy 

<PS_CONFIG_DIR>/ platform.conf.<profile>

For example, /etc/opt/SUNWportal/ platform.conf.<profile> .

<PS_DATA_DIR>/logs/sra/<profile>. For example, /var/opt/SUNWportal/logs/sra/default/ .

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

Rewriter proxy 

<PS_CONFIG_DIR>/ platform.conf.<profile>

For example, /etc/opt/SUNWportal/ platform.conf.<profile> .

<PS_DATA_DIR>/logs/ sra/<profile>.

For example, /var/opt/SUNWportal/ logs/sra/default/ .

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

Rewriter 

/var/opt/SUNWportal/logs/ sra/<PROFILE_NAME>/

The log settings for the particular gateway instance can be configured by modifying the /etc/opt/SUNWportal/ platform.conf.PROFILE_NAME file.

The log files corresponding to each of the above properties are: 

  • portal.rewriter.original.gateway.0.0.log

  • portal.rewriter.rest.gateway.0.0.log

  • portal.rewriter.rewritten.gateway.0.0.log

  • portal.rewriter.rulesetinfo.gateway.0.0.log

  • portal.rewriter.unaffected.gateway.0.0.log

  • portal.rewriter.uriinfo.gateway.0.0.log

Configurable Parameters of a Log Configuration file

You can use the instructions in this section to do the following:

Example 1 A separate file can be set for the logger as follows:

LOGGER_NAME.separatefile=true. For example, debug.com.sun.portal.desktop.separatefile=true.

Example 2 The level for the logger can be set as follows:

LOGGER_NAME.level=LEVEL_NAME. For example, debug.com.sun.portal.level=FINE.

Example 3 A handler can be specified for the logger as follows:

LOGGER_NAME.handler=HANDLER_NAME. For example, debug.com.sun.portal.handler=java.util.logging.FileHandler.

Example 4 A Formatter can be specified for the logger as follows:

LOGGER_NAME.handler.HANDLER_NAME.formatter=FORMATTER_NAME. For example, debug.com.sun.portal.handler.java.util.logging.FileHandler.formatter=com. sun.portal.log.common.PortalLogFormatter.

Viewing the Log Files List

The following table describes the list of options to view log files of the Secure Remote Access components.

Table 4 Component Logs List Command

Component 

Command 

Gateway 

psadmin list-loggers -u adminUser-f passwordfile --component gateway --sra-instance profile

Netletproxy 

psadmin list-loggers -u  

adminUser-f passwordfile --component nlproxy --sra-instance profile

Rewriterproxy 

psadmin list-loggers -u  

adminUser-f passwordfile --component rwproxy --sra-instance profile

Logging Command Line Options

The following three commands are used for logging files for Secure Remote Access components:

Psadmin List-Loggers Command Options

Use this table to review the options available for the list-loggers command.

Table 5 List-Loggers Command Line Options List

Option 

Description 

--adminuser -u userName

Specify the name of the administrator. 

--passwordfile -f password-filename

Specify the administrator password in the password file. 

--component -m component-type

Specify the component type. The valid values are portal, search, pas, gateway, nlproxy, and rwproxy.

--portal | -p portal-ID

Specify the portal ID. This is required only if the component type is portal.

--instance | -i portal-instance-name

Specify the portal server instance. This is required only if the component-type is portal.

--searchserver -s search-server-ID

Specify the search server ID. This is required only if the component type is search.

--sra-instance sra-instance

Specify the SRA instance name. This is required only if the component type is either gateway, nlproxy, or rwproxy.

--detail

Displays detailed information about loggers listed. It includes level, handler information, filename, and filehandler. 

Psadmin Set-Logger Command Options

Table 6 Set-Logger Command Line Options List

Option 

Description 

--adminuser -u userName

Specify the name of the administrator. 

--passwordfile -f password-filename

Specify the administrator password in the password file. 

--component | -m component-type

Specify the component type. The valid values are portal, search, pas, gateway, nlproxy, and rwproxy.

--logger | -O loggerName

Specify the name of the logger. 

--level -L level

Specify the level. 

--portal -p portal-ID

Specify the portal ID. This is required only if the component-type is portal.

--instance -i portal-instance-name

Specify the portal server instance. This is required only if the component type is portal.

--searchserver -s search-server-ID

Specify the search server ID. This is required only if the component type is search.

--sra-instancesra-instance-name

Specify the SRA instance name. This is required only if the component type is either gateway, nlproxy, or rwproxy.

--file -F

Specify if the logger is to be logged to a separate file. 

--stack-trace -T

This option can be specified only if --file option is specified. Specifies whether the stack trace should be printed in the log file. If this option is specified, the --parent option cannot be specified. The default is false. If you specify true, then the stack trace is printed in the log file.

--parent -P

This option can be specified only if --file option is specified. Specifies whether the log data should be printed in the parent log file of the current logger. If this option is specified, --stack-trace option cannot be specified. The default is false, if you do not specify the option, the log data is printed only in the current logger's log file. If you specify true, the log data is printed in the parent log file and also in the current logger's log file.

Psadmin Reset-Logger Command Options

Table 7 Reset-Logger Command Line Options List

Option 

Description 

--adminuser -u userName

Specify the administrators name. 

--passwordfile -f password-filename

Specify the administrator password in the password file. 

--component | -m component-type

Specify the component type. The valid values are portal, search, pas, gateway, nlproxy, and rwproxy.

--logger | -O loggerName

Specify the name of the logger.  

--portal -p portal-ID

Specify the portal ID. This is required only if the component-type is portal.

--instance -i portal-instance-name

Specify the portal server instance. This is required only if the component type is portal.

--searchserver -s search-server-ID

Specify the search server ID. This is required only if the component type is search.

--sra-instancesra-instance-name

Specify the SRA instance name. This is required only if the component type is either gateway, nlproxy, or rwproxy.

Frequently Asked Questions on Logging

When a separate file is created, what is the name of the new file?

When a separate file is created, the filename is the same as the logger name except debug.com.sun. For example, if a separate file is set for the logger debug.com.sun.portal.desktop, the file name will be portal.desktop.0.0.log.

What is the format used to log the content in the file?

The format to log the content is: |DATETIME|LOG_LEVEL|PRODUCT_ID|LOGGER NAME|KEY VALUE PAIRS|MESSAGE|

When is the stack trace logged?

The logging of stack trace is determined by the stacktrace property. This value is applicable only if the format is PortalLogFormatter. debug.com.sun.portal.stacktrace=false. If the value is false, the stack trace is logged only if the levels is either SEVERE or WARNING. If the value is true, the stack trace is always logged.