Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Portal Server 6 2005Q4 Deployment Planning Guide 

Appendix D  
Troubleshooting Your Portal Deployment

This appendix describes how to troubleshoot the Sun Java™ System Portal Server software and the Sun Java System Portal Server Secure Remote Access (SRA) software.

This appendix contains the following sections:

Troubleshooting Portal Server

This sections contains troubleshooting information for Sun Java System Portal Server.

UNIX Processes

For the portal to be functioning properly, check that the following root-owned processes are running. Use the ps command to see this output.

Sun Java System Directory Server:

/ns-slapd -D /usr/ldap/slapd-server -i /usr/ldap/slapd-server/logs/pid

Sun Java System Access Manager:

identity-server-install-root/SUNWam/bin/doUnix -c 8946

Sun Java System Portal Server:

./uxwdog -d portal-server-install-root/SUNWam/servers/https-server/config

ns-httpd -d portal-server-install-root/SUNWam/servers/https-server/config

Admin Web Server (optional, but usually running):

./uxwdog -d web-container-install-root/SUNWam/servers/https-admserv/config

ns-httpd -d web-container-install-root/SUNWam/servers/https-admserv/config

Log Files

Examine the following log files for errors.

Sun Java System Web Server (errors and access):


Sun Java System Directory Server:


Recovering the Search Database

The Search database maintains recoverable transaction logs. Thus, under normal circumstances, you do not have to do anything to recover the database. Recovery from errors and transient conditions such as a full disk are straight forward. If desired, maintain Search database archives and restore from an archive in case you lost the entire database. In this scenario, you would copy the archive to the original database to recover it.

    To Recover the Database
  1. Stop all processes accessing the database, including the Portal Server instance.
  2. Use the rdmgr -R command to recover.

Working with the Display Profile

If you need to troubleshoot the XML contents of your portal’s display profile, extract the contents to a file for examination. At some point in the troubleshooting process, it might be useful to reload the display profile.

    To Extract the Display Profile
  1. Login as administrator.
  2. Use the dpadmin command to extract the display profile. For example:
  3. ./dpadmin list -u "uid=amAdmin,ou=People,,o=isp" -w password -d ",o=isp" > /tmp/displayxml

    This example puts the contents of the display profile into the /tmp/displayxml file.

    To Reload the Display Profile
  1. Login as administrator.
  2. Use the dpadmin command to reload the display profile. For example:
  3. ./dpadmin modify -u "uid=amAdmin,ou=People,,o=isp" -w password -d ",o=isp" /tmp/updated_displayxml

    This example reloads the contents of the display profile from the /tmp/updated_displayxml file.

High CPU Utilization for Portal Server Instance

When using the Cisco Content Services Switch, you might see a very high CPU utilization on the Portal Server instance with Sun Java System Web Server error file showing the following message every five seconds.

[20/Jan/2003:16:53:36] failure ( 5926): Error accepting connection -5928, oserr=130 (Connect aborted)

The cause of this error is a “sticky bit” setting within the Cisco Content Services Switch that is causing these errors. These load balancers periodically ping the servers (every five seconds) to verify that the servers are alive. After turning off the “sticky bit” setting, which disables the ping to the server every 5 seconds, the errors will no longer show up in the Web Server product.

Configuring a Sun Java System Portal Server Instance to Use an HTTP Proxy

If the Portal Server software is installed on a host that cannot directly access certain portions of the Internet or your intranet, you can receive errors. For example, when using the SampleSimpleWebService provider, you might see the following error when the proxy has not been configured:

    To Configure Usage of an HTTP Proxy for a Portal Server Instance
  1. Change directories to the portal server install root directory containing the configuration for the instance.
  2. cd portal-server-install-root/SUNWam/servers/https-servername/config

  3. Edit the server.xml file within this directory and add the following lines:
  4. http.proxyHost=proxy-host



    where proxy-host is the fully-qualified domain name of the proxy host, proxy-port is the port on which the proxy is run, and portal-host is the fully qualified domain name of the portal host.

Troubleshooting SRA

This section describes how to capture information that Sun Java System support personnel need to troubleshoot problems in your deployment.

Debugging the Gateway

To turn debugging on or off, you set the level of debugging or set it to off. The following steps describe what to do.

  1. Log in as root to the Gateway machine and edit the following file:
  2. gateway-install-root/SUNWam/config/

  3. Set the debug level:

    The debug levels are:

    error - Only serious errors are logged in the debug file. Rewriter usually stops functioning when such errors occur.

    warning - Warning messages are logged.

    message - All debug messages are logged.

    off - No debug messages are logged.

  5. Specify the directory for the debug files in the following property of the file:

    where /var/opt/SUNWam/debug is the default debug directory.

  7. Restart the Gateway from a terminal window:
  8. gateway-install-root/SUNWps/bin/gateway -n gateway-profile-name start

Introduction to shooter

The shooter tool captures all the information that the development and support team will require to troubleshoot problems in your deployment of the Sun Java System Portal Server Secure Remote Access product. You can also run this tool on a Portal Server machine.

This tool captures the following data:

Using shooter

The shooter tool includes five files as described below.

This is the main script. Run this script after a test or just before starting a test on the SRA installation.

From portal-server-install-root/bin/perf, type:


This tool collects data under a temporary folder and displays the folder name.

This script collects and formats the garbage collection output from the JVM.

To run gctool, start the Gateway, and type the following to redirect the output to this script and allow collection throughout the test.

/etc/init.d/Gateway -n default start |


Before running gctool, ensure that you include -verbose:gc in the Gateway script in the “CMD” section. The Gateway script resembles the following:

-server -verbose:gc -Xms1G -Xmx2G -XX:+OverrideDefaultLibthread -XX:ThreadStackSize=128 -XX:MaxPermSize=128M -XX:PermSize=128M -XX:MaxNewSize=256M -XX:NewSize=256M

At the end of the test period, run shooter to collect the output of gctool along with other data.

This script tracks the memory footprint of a process. Start this script after starting the Gateway and allow it to run during the duration of the test. The largest process with the given name or PID is tracked after every specified number of seconds.

To run memfoot, type:

./memfoot java 60

The output of this script is a time-stamped process status file. The shooter tool collects this output along with the rest of the data.

This script is used internally by shooter to find unique lines and their count. The advantage over the system uniq script is that it finds non-adjacent unique lines.


This class is called internally by shooter to obtain the Gateway settings in the Access Manager administration console.

SRA Log Files

Examine the following log files for errors.







Previous      Contents      Index      Next     

Part No: 819-4155.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.