WebSphere

  • Updated on Sep 8, 2023
  • 3 minute(s) read
Prev Next
About this Article
This article provides VSP application instrumentation steps for IBM WebSphere application aerver and provides the steps to determine the values of deployment folder and start-up script path required during application configuration on CMS.


Variables %WAS_HOME% and $WAS_HOME used throughout this article refer to the root directory where WebSphere Server is installed in Windows and Linux operating systems respectively. 

Some sample values are provided below:

  • %WAS_HOME% - D:\IBM\WebSphere\AppServer
  • $WAS_HOME - /opt/WAS/WebSphere/AppServer
NOTE
Refrain from using auto-instrumentation with WebSphere. Opt for manual instrumentation


Windows

Pre-requisites

If the WebSphere Admin Server is not running, start the Admin Server using the procedures mentioned below:

  1. At the command prompt, execute the below command as Administrator
    %WAS_HOME%\profiles\Dmgr01\bin\startManager.bat
  2. Log in to IBM WebSphere Admin Server console with valid credentials


Auto Instrumentation

  1. Select the application to be instrumented from the list:
    1. Navigate to Applications > Application Types > WebSphere enterprise applications in the left navigation pane
    2. Click on the required Application in the right panel
  2. Associated JVM Instance 
    1. Navigate to Applications > Application Types > WebSphere enterprise applications in the left navigation pane 
    2. Click on the required Application in the right panel
    3. Click Target specific application status to get JVM information
  3. Navigate to System Administration > Nodes in the left navigation pane. The Hostname where WebSphere instances are running is displayed
  4. Application Deployment Folder:
    1. Log in to the WebSphere host 
    2. Navigate to the directory: %WAS_HOME%\profiles\<ProfileName>\installedApps\<Cell Name>
    3. Example: D:\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\Dmgr01Cell01
  5. Start Up Script File Path:
    1. Log in to the WebSphere host
    2. Navigate to the directory:  %WAS_HOME%\profiles\<ProfileName>\config\cells\<Cell Name>\nodes\<Node Name>\servers\<Server Name>\server.xml
    3. Example: D:\IBM\WebSphere\AppServer\profiles\AppSrv01\config\cells\Dmgr01Cell01\nodes\AppSrv01Node01\servers\server1\server.xml


Manual Instrumentation

  1. Log in to IBM WebSphere Admin Server console with valid credentials
  2. Navigate to System Administration > Node agents in the left navigation pane
  3. Verify whether the Node Agent is running
  4. If the agent Is not running, execute the below command:
    %WAS_HOME%\profiles\AppSrv01\bin\startNode.bat
  5. Navigate to Servers > Server Types > WebSphere application Servers > <Application_Instance> in the left navigation pane
    1. If the Instance is running, Click Stop to stop the instance


IAE-Java Instrumentation

  1. Navigate to Servers > Server Types > WebSphere application Servers > Application servers > <Server Name> > Process Definition > Java Virtual Machine in the left navigation pane
  2. Add the below JVM argument to Generic JVM arguments field. Ensure that <AppCollectiveID> mentioned below is replaced with the App Collective ID in the CMS Application Configuration section
    -javaagent:c:\PROGRA~2\Virsec\virsec-web-mem\iae-java\instrumentation.jar -Dvirsec_appcontextpath=<App.CollectiveID>
  3. Click Apply > Review
  4. Select the option Synchronize changes with Nodes. Click Save
  5. Navigate to Servers > Server Types > WebSphere application Servers > <Probe> in the left navigation pane
    1. Click Start to start the target WebSphere Server Instance
  6. Application Deployment Folder:
    1. Log in to the WebSphere host 
    2. Navigate to the directory: %WAS_HOME%\profiles\<ProfileName>\installedApps\<Cell Name>
    3. Example: D:\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\Dmgr01Cell01
  7. Start Up Script File Path:
    1. As the VSP-JVM arguments are configured manually, create a dummy file and provide the file path as Start Up Script File Path in the CMS


Linux

Pre-requisites

If the WebSphere Admin Server is not running, start the Admin Server using the procedure mentioned below:

  1. At the command prompt, execute the below command as Administrator
    $WAS_HOME/profiles/Dmgr01/bin/startManager.sh
  2. Log in to IBM WebSphere Admin Server console with valid credentials


Auto Instrumentation

  1. Select the application to be instrumented from the list:
    1. Navigate to Applications > Application Types > WebSphere enterprise applications in the left navigation pane
    2. Click on the required Application in the right panel
  2. Associated JVM Instance 
    1. Navigate to Applications > Application Types > WebSphere enterprise applications in the left navigation pane 
    2. Click on the required Application in the right panel
    3. Click Target specific application status to get JVM information
  3. Navigate to System Administration > Nodes in the left navigation pane. The Hostname where WebSphere instances are running is displayed
  4. Application Deployment Folder:
    1. Log in to the WebSphere host 
    2. Navigate to the directory: $WAS_HOME/profiles/<ProfileName>/installedApps/<Cell Name>
    3. Example: /opt/IBM/WebSphere/AppServer/profiles/AppSrv01/installedApps/Dmgr01Cell01
  5. Start Up Script File Path:
    1. Log in to the WebSphere host
    2. Navigate to the directory:  $WAS_HOME/profiles/<ProfileName>/config/cells/<Cell Name>/nodes/<Node Name>/servers/<Server Name>/server.xml
    3. Example: /opt/IBM/WebSphere/AppServer/profiles/AppSrv01/config/cells/Dmgr01Cell01/nodes/AppSrv01Node01/servers/server1/server.xml


Manual Instrumentation

  1. Log in to IBM WebSphere Admin Server console with valid credentials
  2. Navigate to System Administration > Node agents in the left navigation pane
  3. Verify whether the Node Agent is running
  4. If the agent Is not running, execute the below command:
    $WAS_HOME/profiles/AppSrv01/bin/startNode.sh
  5. Navigate to Servers > Server Types > WebSphere application Servers > <Application_Instance> in the left navigation pane
    1. If the Instance is running, Click Stop to stop the instance


IAE-Java Instrumentation

  1. Navigate to Servers > Server Types > WebSphere application Servers > Application servers > <Server Name> > Process Definition > Java Virtual Machine in the left navigation pane
  2. Add the below JVM argument to Generic JVM arguments field. Ensure that <AppCollectiveID> mentioned below is replaced with the App Collective ID in the CMS Application Configuration section
    -javaagent:/opt/virsec-web-mem/iae-java/instrumentation.jar - Dvirsec_appcontextpath=<App.CollectiveID>
  3. Click Apply > Review
  4. Select the option Synchronize changes with Nodes. Click Save
  5. Navigate to Servers > Server Types > WebSphere application Servers > > <Probe> in the left navigation pane
    1. Click Start to start the target WebSphere Server Instance
  6. Application Deployment Folder:
    1. Log in to the WebSphere host 
    2. Navigate to the directory:  $WAS_HOME/profiles/<ProfileName>/installedApps/<Cell Name>
    3. Example: /opt/IBM/WebSphere/AppServer/profiles/AppSrv01/installedApps/Dmgr01Cell01
  7. Start Up Script File Path:
    1. As the VSP-JVM arguments are configured manually, create a dummy file and provide the file path as Start Up Script File Path in the CMS