Sun Gathering Debug Data for Sun Java System Portal Server

1.5 What Portal Server Debug Data Should You Collect?

This section describes the kinds of debug data that you need to provide based on the kind of problem you are experiencing.

This section contains the following tasks:

ProcedureTo Collect Required Debug Data for Any Portal Server Problem

All problems described in this technical note need basic information collected about when the problem occurred and about the system having the problem. Use this task to collect that basic information.

For problems with Portal Server Secure Remote Access (gateway), you need to collect data from both the portal and gateway hosts if they are separate (the usual configuration in a production environment). If possible, provide the output from Sun Explorer Data Collector (SUNWexplo) of the machine where the problem occurred.

  1. Note the day(s) and time(s) the problem occurred.

  2. Provide a graphical representation of your deployment. Include all hosts and IP addresses, host names, operating system versions, role they perform, and other important systems such as load balancers, firewalls, and so forth.

  3. For Solaris OS systems, use the ps6info.sh script to gather all the necessary information. For HP-UX, Linux, and Windows platforms, or if you do not have the ps6info.sh script, continue with the remaining steps.

  4. Note the operating system.

    Solaris OS

    uname -a

    HP-UX

    uname -r

    Linux

    more /etc/redhat-release

    Windows

    C:\Program Files\Common files\Microsoft Shared\MSInfo\msinfo32.exe /report C:\report.txt

  5. Note the patch level.

    Solaris OS

    patchadd -p

    HP-UX

    swlist

    Linux

    rpm -qa

    Windows

    Already provided in the C:\report.txt file above.

  6. Get the /etc/opt/SUNWps/.version file (or .version-sra for the Portal Server Secure Remote Access).

  7. Note the web container (Sun Java System Web Server, Sun Java System Application Server, BEA WebLogic, or IBM WebSphere).

  8. Get the log files.

    UNIX and Linux

    /var/opt/SUNWps/*

    Windows

    server-root\instance-dir\portal\logs\*


    Note –

    If possible, provide just the relevant extracts of log files for the same time period that show the problem, with sufficient context to see what else was occurring during the error occurrence and shortly before. Thus for relatively short log files, send the entire log file, whereas for long-running hence large log files, an extract might be more appropriate, though be sure to include all the material from the time of the error as well as at least some lead-in logging from before the error apparently occurred.


  9. Get the configuration file.

    UNIX and Linux

    more /etc/opt/SUNWps/.version (or .version-sra for Secure Remote Access)

    Windows

    more server-root\.version (or .version-sra for Secure Remote Access)

ProcedureTo Collect Debug Data on Portal Server Installation Problems

Follow these steps if you are unable to complete the installation or if you get a “failed” installation status for Portal Server.

  1. Consult the following troubleshooting information:

    If the problem persists after using this troubleshooting information, then continue with this procedure to collect the necessary data for the Sun Support Center.

  2. Collect the general system information as explained in To Collect Required Debug Data for Any Portal Server Problem.

  3. Specify if this is a first-time installation or a Hot Fix installation on a pre-existing Sun ONE Portal Server instance.

  4. Get the installation logs.

    • On Solaris OS systems and Sun ONE Portal Server (Portal Server 6.0 and 6.1) systems, get the following logs:

      /var/sadm/install/logs/pssetup.install.pid/*

    • On Windows systems, if you chose the Config Later option during the installation, provide the following log files:

      server-root\instance_dir\portal\config\logs\*

  5. Get the install error messages.

    Solaris OS

    /var/sadm/install/logsThe log file names start with Java_Enterprise_System*_install.Bdatetime, where date and time correspond to the failing installing (for example, B12161532).

    Linux and HP-UX

    /var/opt/sun/install/logsThe log file names start with Java_Enterprise_System*_install.Bdatetime, where date and time correspond to the failing installing (for example, B12161532).

    Windows

    C:\DocumentsandSettings\current-user\LocalSettings\TempThe log file names start with MSI*.log (usually a text file). The asterisk (*) represents a random number in the Temp directory for each MSI based setup.

ProcedureTo Collect Debug Data on a Hung or Unresponsive Portal Server Process

A process hang is defined as one of the Portal Server processes not responding to requests anymore while the process is still running locally. The Portal Server processes are:

  1. Collect the general system information as explained in To Collect Debug Data on Portal Server Installation Problems.

  2. (Secure Remote Access only) Consult the following information.


    http://sunsolve.sun.com/search/document.do?assetkey=1-25-75583-1&searchclause=75583

    If the problem persists after using this information, then continue with this procedure to collect the necessary data for the Sun Support Center.

  3. (Secure Remote Access only) Can you connect to the Portal Server host when you bypass the gateway host?

    If yes, the gateway java process is hung. Collect the debug data that follows on this process and not on the Portal Server container process.

  4. Get the pid of the Web Server process.

    Solaris OS and HP-UX

    ps -ef | grep uxwdogThe result will give you the PID of the uxwdog daemon, for example, 11449:

    Linux

    ps -ef | grep ns-hhtpd

    Windows

    C:\windbg-root>tlist.exe

    For example, on Solaris OS:


    # ptree 11449
    11449 ./uxwdog -d /prods/crypto/60SP6/https-sun/config
       11450 ns-httpd -d /prods/crypto/60SP6/https-sun/config
         11451 ns-httpd -d /prods/crypto/60SP6/https-sun/config

    You want to gather data on the highest PID process, which in this example is 11451. The Web processes is either ns-hhtpd or webservd depending on the Web Server version.

  5. Note the day and time that the process hang occurred.

  6. Get the output of the following command.

    UNIX and Linux

    netstat -an | grep web-port (or gateway-port)

    Windows

    netstat -an | web-port (or gateway-port)

  7. For Solaris OS systems, the iwshang script gathers all the following debug data for you, except the output of the pkg_app script.

    You must run the pkg_app script as indicated on one of core files generated by the iwshang script. Be sure to launch the iwshang script on the valid PID. For HP-UX, Linux, and Windows platforms, or if you do not have the iwshang script, continue with the remaining steps. See To Run the iwshang Script for more information.

  8. Run the following commands and save the output.

    Solaris OS

    ps -ef | grep server-rootvmstat 5 5iostat -xtopuptime

    HP-UX

    ps -aux | grep server-rootvmstat 5 5iostat -xtopsar

    Linux

    ps -aux | grep server-rootvmstat 5 5topuptimesar

    Windows

    Obtain the WEB process PID: C:\windbg-root>tlist.exe

    Obtain process details of the WEB running process PID: C:\windbg-root>tlist.exe web-pid

  9. Get the swap information.

    Solaris OS

    swap -l

    HP-UX

    swapinfo

    Linux

    free

    Windows

    Already provided in C:\report.txt as described in To Collect Debug Data on Portal Server Installation Problems.

  10. For Unix-Linux systems, if you are able to isolate the hanging process, get the following debug data for that process. Otherwise, get the following data for each of the Web Server processes. For Windows systems, get the following data for the webservd.exe or ns-httpd.exe process.

    1. For Solaris OS only, using the PID obtained in Step 4, get a series of five of the following commands (one every 10 seconds):

      pstack web-pid

      pmap -x web-pid

    2. For Solaris OS only, get the output of the following commands:

      prstat -L -p web-pid

      pmap web-pid

      pfiles web-pid

  11. Get the output of the following command.

    Solaris OS

    truss -ealf -rall -wall -vall -o /tmp/web-pid.truss -p web-pid

    HP-UX

    tusc -v -fealT -rall -wall -o /tmpweb-pid.tusc -p web-pid

    Linux

    strace -fv -o /tmp/web-pid.strace -p web-pid

    Windows

    Use DebugView: http://www.sysinternals.com/Utilities/DebugView.html


    Note –

    Wait one minute after launching the appropriate command (truss, strace, tusc, or DebugView) then stop it by pressing Control-C in the terminal where you launched the command.


  12. Get the the Directory Server Access, Errors, and Audit logs used by Portal Server.

    UNIX and Linux

    server-root/slapd-identifier/logs/accessserver-root/slapd-identifier/logs/errors server-root/slapd-identifier/logs/audit (if enabled)

    Windows

    server-root\slapd-identifier\logs\accessserver-root\slapd-identifier\logs\errors server-root\slapd-identifier\logs\audit (if enabled)

  13. Get core files and the output of the following commands.

    In a process hang situation, it is helpful to compare several core files to review the state of the threads over time. To not overwrite a core file, copy that core file to a new name, wait approximately one minute then rerun the following commands. Do this three times to obtain three core files.


    Note –

    For HP-UX, you need the following two patches to use the gcore command: PHKL_31876 and PHCO_32173. If you cannot install these patch, use the HP-UX /opt/langtools/bin/gdb command from version 3.2 and later, or the dumpcore command.


    Solaris OS

    cd server-root/bin/https/bingcore -o /tmp/web_process-core Archive the result of the pkg_app script:./pkg_app.ksh PID-of-application corefile

    The output of the pkg_app script is required to analyze the core files.


    Note –

    Make sure that you have set the size of the core dumps to unlimited by running the ulimit command. and that the user is not nobody. Also, check the coreadm command for additional control. See 1.6 Configuring Solaris OS to Generate Core Files if a core file isn't generated.


    HP-UX

    # gcore -p web-pid
    (gdb) attach web-pid
    Attaching to process web-pid
    No executable file name was specified
    (gdb) dumpcore
    Dumping core to the core file core.web-pid
    (gdb) quit
    The program is running. Quit anyway (and detach it)? (y or n) y
    Detaching from program: , process web-pid
    

    The file core.web-pid should be generated in the https-instance/config directory.

    Linux

    cd server-root/bin/https/bin
    # gdb
    (gdb) attach web-pid
    Attaching to process web-pid
    No executable file name was specified
    (gdb) gcore
    Saved corefile core.web-pid
    
    (gdb)backtrace
    (gdb)quit
    
    Windows

    Get the WEB process PID:

    C:\windbg-root>tlist.exe

    Generate a crash dump on the WEB running process PID:

    C:\windbg-root>adplus.vbs -hang -p web-pid -o C:\crashdump_dir


    Note –

    For Windows, provide the complete generated folder under C:\crashdump_dir.


  14. Get the Access Manager configuration file.

    UNIX and Linux

    /opt/SUNWam/lib/AMConfig.properties

    Windows

    access-manager-server-root\lib\AMConfig.properties

  15. Get the Access Manager log files.

    UNIX and Linux

    /var/opt/SUNWam/*

    Windows

    access-manager-server-root\debug\*

  16. Get network trace files between the gateway and the portal hosts, and between the client and the portal host.

    Make sure that all the data collection is done over the same time frame in which you had the problem. Try to indicate the hung process if possible.


    Note –

    Indicate clearly all IP addresses and host names for each component to correctly read these network traces.


    Solaris OS

    snoop -V -vvv -d interface-o /tmp/gw-snoop-portal ip-portal-server

    HP-UX

    tcpdump -i interface -w /tmp/gw-snoop-portal ip-portal-serverThe tcpdump command is available here:http://hpux.connect.org.ukYou can use the native nettl command too.

    Linux

    tethereal -V -F snoop -i interface -w /tmp/gw-snoop-portal ip-portal-server


    Note –

    The tethereal command already should be installed. If not, get it from the following location: http://www.ethereal.com. You can also use the ethereal GUI or the tcpdump command.


    Windows

    tethereal -vvv -i interface -w /tmp/gw-snoop-portal host ip-portal-server


    Note –

    The tethereal command is available at the following location: http://www.ethereal.com. You can also use the ethereal GUI.


ProcedureTo Collect Debug Data on a Portal Server Crashed Process

Use this task to collect data when a Portal Server process has stopped (crashed) unexpectedly. Run all the commands on the actual machine where the core file(s) were generated.

  1. Collect the general system information as explained in To Collect Required Debug Data for Any Portal Server Problem.

  2. Get the output of the following commands.

    Solaris OS

    ps -ef | grep server-rootvmstat 5 5iostat -xtopuptime

    HP-UX

    ps -aux | grep server-rootvmstat 5 5iostat -xtopsar

    Linux

    ps -aux | grep server-rootvmstat 5 5topuptimesar

    Windows

    Obtain the PROXY process PID: C:\windbg-root>tlist.exe

    Obtain process details of the PROXY running process PID: C:\windbg-root>tlist.exe proxy-pid

  3. Get the swap information.

    Solaris OS

    swap -l

    HP-UX

    swapinfo

    Linux

    free

    Windows

    Already provided in C:\report.txt as described in To Collect Required Debug Data for Any Portal Server Problem.

  4. Get the system logs.

    Solaris OS and Linux

    /var/adm/messages/var/log/syslog

    HP-UX

    /var/adm/syslog/syslog.log

    Windows

    Event log files:Start-> Settings-> Control Panel —> Event Viewer-> Select LogThen click Action-> Save log file as

  5. Get the the Directory Server Access, Errors, and Audit logs used by Portal Server.

    UNIX and Linux

    server-root/slapd-identifier/logs/accessserver-root/slapd-identifier/logs/errors server-root/slapd-identifier/logs/audit (if enabled)

    Windows

    server-root\slapd-identifier\logs\accessserver-root\slapd-identifier\logs\errors server-root\slapd-identifier\logs\audit (if enabled)

  6. Get the Access Manager configuration file.

    UNIX and Linux

    /opt/SUNWam/lib/AMConfig.properties

    Windows

    access-manager-server-root\lib\AMConfig.properties

  7. Get the Access Manager log files.

    UNIX and Linux

    /var/opt/SUNWam/*

    Windows

    access-manager-server-root\debug\*

  8. Get core files (called “Crash Dumps” by Windows).

    Solaris OS

    See 1.6 Configuring Solaris OS to Generate Core Files if a core file was not generated.

    Linux

    Core dumps are turned off by default in the /etc/profile file. You can make per user changes by editing your ~/.bash_profile file. Look for the following line:

    ulimit -S -c 0 > /dev/null 2>&1

    You can either comment out the entire line to set no limit on the size of the core files or set your own maximum size.

    Windows

    Generate a crash dump during a crash of Portal Server by using the following commands:

    Get the PORTAL process PID : C:\windbg-root>tlist.exeGenerate a crash dump when the PORTAL process crashes: C:\windbg-root>adplus.vbs -crash -FullOnFirst -p portal-pid -o C:\crashdump_dir

    The adplus.vbs command watches portal-pid until it crashes and will generate the dmp file. Provide the complete generated folder under C:\crashdump_dir.


    Note –

    If you didn't install the Debugging Tools for Windows, you can use the drwtsn32.exe -i command to select Dr. Watson as the default debugger. Use the drwtsn32.exe command, check all options, and choose the path for crash dumps. Then provide the dump and the drwtsn32.log files.


  9. (Solaris OS only) For each core file, provide the output of the following commands.

    file corefile
    pstack corefile
    pmap corefile
    pflags corefile
    
  10. (Solaris OS only) Archive the result of the script pkg_app (one core file is sufficient).

    ./pkg_app.ksh Pid-of-application corefile
    

    Note –

    The Sun Support Center must have the output from the pkg_app script to properly analyze the core file(s).