+

Search Tips   |   Advanced Search


Instrument servers using the command prompt


Overview

Instrument appservers to collect response time breakdown data.

The data collection infrastructure must be installed on any computer from which to collect performance data. The application server must be running.


Instrument a server from the command prompt

  1. Open a command prompt and go to the rpa_prod folder in the directory where the data collection infrastructure is installed. By default, in Windows this directory is...

      C:\IBM\IBM\SDP\DCI\rpa_prod

  2. Type the command name with the arguments to use to instrument a server. See the examples that follow.

    The instrumentation utility is instrumentServer.sh|bat

    Enter the command name with no arguments to see the syntax details for the command.

    $ ./instrumentServer.bat
    
    Usage: instrumentServer [-install | -uninstall | -help] 
                             -type <type> 
                             -serverName <name> 
                             -serverHome <home> 
                            [-user <username> -password <password>] 
    
      -commandline                  -- Use the command line console script instead of the GUI
      -install                      -- Install J2EE instrumentation.
      -uninstall                    -- Uninstall J2EE instrumentation.
      -force                        -- Force the uninstall and ignore errors. 
                                       Warning: Use this only as a last resort, 
                                       as it may leave servers in an improper state.
      -type <type>                  -- The type of server (IBM or BEA).
      -serverName <name>            -- Server instance name (e.g. server1).
      -serverHome <path>            -- Server install location.
      -user <username>              -- Application server user name.
      -password <password>          -- Application server password.
      ...                           -- Server type-specific options.
    
      IBM WebSphere Application Server options (<type> equals IBM)
      -serverVersion <version>      -- Application server version (5 or 6).
      -profileName <name>           -- Profile name (version 6 only).
      -embedded                     -- For embedded unit test environment servers.
    
      BEA WebLogic Application Server options (<type> equals BEA)
      -nodeManaged                  -- Used when server is node managed.
      -javaHome <path>              -- Application server Java home.
      -adminServerHost <host>       -- Domain administrative server host.
      -adminServerPort <port>       -- Domain administrative server port.
      -startScript <scriptfile>     -- Full path to script that starts the server.
    

  3. After you have instrumented the application server, restart the application server. Instrumentation changes take effect after you restart the application server.


Examples

Instrument a Linux computer equipped with WAS V5.0 or later, where the server is named server1, installed in /opt/WebSphere/AppServer, with no security...

./instrumentServer.sh -install \
                      -type IBM\
                      -serverName server1\
                      -serverHome  /opt/WebSphere/AppServer\
                      -serverVersion 5

Instrument a Linux computer equipped with WAS V6.0, where the server named server2, installed in /opt/WebSphere/AppServer, the profile name is default, and security is enabled...

./instrumentServer.bat -install \
                       -type IBM \
                       -serverName server2 \
                       -serverHome  /opt/WebSphere/AppServer
                       -serverVersion 6  \
                       -profileName default \
                       -user my_WAS_userId \
                       -password my_WAS_password

Instrument a Windows computer equipped with WAS V5.0 or later, where the server is named my_Server, installed in C:\IBM\was5.x, with security enabled...

./instrumentServer.bat -install \
                       -type IBM \
                       -serverName my_Server  \
                       -serverHome "C:\IBM\was5.x" \
                       -user my_WAS_userId -password my_WAS_password \
                       -serverVersion 5

Instrument a Windows computer equipped with WAS V6.0, where the server is named my_Server2, installed in C:\IBM\was6.0, the profile name is default and security enabled...

instrumentServer -install \
                 -type IBM\
                 -serverName my_Server2  \
                 -serverHome "C:\IBM\was6.0" \
                 -user my_WAS_userId \
                 -password my_WAS_password \
                 -serverVersion 6 \
                 -profileName default

Instrument a Windows system equipped with a WebLogic application server, with configuration details as indicated...

instrumentServer -install \
                 -type BEA \
                 -serverName server1  \
                 -serverHome C:\bea\weblogic81 \
                 -javaHome C:\bea\jdk141_02  \
                 -adminServerHost localhost \
                 -adminServerPort 7001  \
                 -user my_BEA_userID \
                 -password my_BEA_password  \
                 -startScript C:\bea\weblogic81\mydomain\startManagedWeblogic.cmd 

Instrument a Linux computer equipped with a WebLogic application server, with configuration details as indicated...

./instrumentServer.sh -install \
                      -type BEA \
                      -serverName server1 \
                      -serverHome  /opt/bea/weblogic81 \
                      -javaHome /opt/bea/jdk141_02 \
                      -adminServerHost hostname.xyz.com \
                      -adminServerPort 7001 \
                      -user my_BEA_userId \
                      -password my_BEA_password \
                      -startScript /opt/bea/weblogic81/mydomain/startManagedWeblogic.sh

The WebLogic server must be started with the JVM that is included with RPTv8. The JRockit VM is not a supported JVM. For managed WebLogic servers, the Java Home variable (listed under Configuration > Remote Start) must point to the Sun JVM shipped with WebLogic.


What to do next

Repeat the instrumentation steps for each application server involved in any data collection for the applications that you will profile. Typically, there will be only one application server.


Related

  • Data collection infrastructure overview


    Related tasks

  • Instrumenting local servers
  • Instrumenting remote servers
  • Starting the data collection infrastructure
  • Stopping the data collection infrastructure
  • Remove instrumentation
  • Remove instrumentation using the command prompt