Installation - Startup Parameters for Java Agent on a WebSphere Application Server

WebSphere Compatibility

vFunction supports IBM WebSphere 8.5.5 and later.

Installation Workflow

  1. Install the Dynamic Analysis Controller
  2. Open the vFunction Agent Startup Parameters in a text editor

    ### Replace the INSTANCE_NAME with the actual value

    less etc/sysconfig/vfunction/agent/instances/INSTANCE_NAME/vmargs-examples/websphere
  3. In the WebSphere Administration Console, click Servers
  4. Expand Server Type, then click WebSphere application servers
  5. Expand Java and Process Management, then click Process Definition
  6. Under the Additional Properties section, click Java Virtual Machine
  7. Scroll down and locate the textbox for Generic JVM arguments
  8. Copy-and-paste the vFunction Agent Startup Parameters and save the changes
  9. Restart the WebSphere instance
  10. Confirm that the Application comes up and functions as expected
  11. If any issues arise:

Sample contents of vmargs-example/websphere file

If using this sample below, you will need to:

  1. Find-and-replace the REPLACE_BASE_DIR with the value relevant to your vFunction installation
  2. Find-and-replace the REPLACE_INSTANCE with the value relevant to your vFunction installation

This sample file exists in the Installation TGZ in /opt/vfunction/controller-installation/stuff/agent/vmargs-examples/java/websphere. Once the install.sh script is run, the relevant placeholder fields are replaced in the version of the environmentally-specific file in /etc/sysconfig/vfunction/agent/instances/INSTANCE_NAME/websphere.

Sudo Installation Sample
### Replace REPLACE_INSTANCE with the actual value, such as default-java
### Replace REPLACE_EXTRA_JVM if using Java 11 or 17

-agentpath:/opt/vfunction/agent/libJVMTIAgent.so -javaagent:/opt/vfunction/agent/runtime-agent.jar REPLACE_EXTRA_JVM -Dcom.vfunction.instance=REPLACE_INSTANCE -Xshareclasses:none -Djavax.management.builder.initial= -Djava8.util.Spliterators.assume.oracle.collections.impl=false
Sudoless Installation Sample
### Replace REPLACE_BASE_DIR with the actual value, such as /home/USERNAME/
### Replace REPLACE_INSTANCE with the actual value, such as default-java
### Replace REPLACE_EXTRA_JVM if using Java 11 or 17

-agentpath:/REPLACE_BASE_DIR/vfunction/opt/vfunction/agent/libJVMTIAgent.so=conf=REPLACE_BASE_DIR/vfunction/etc/sysconfig/vfunction/agent/instances/REPLACE_INSTANCE/native-conf.json -javaagent:REPLACE_BASE_DIR/vfunction/opt/vfunction/agent/runtime-agent.jar=ConfigLocation=REPLACE_BASE_DIR/vfunction/etc/sysconfig/vfunction/agent/instances/REPLACE_INSTANCE/vfunction-runtime-override.properties REPLACE_EXTRA_JVM -Dcom.vfunction.runtime.shared.folder=REPLACE_BASE_DIR/vfunction/opt/vfunction/controller/instances/REPLACE_INSTANCE/temp/ -Dcom.vfunction.runtime.offload.tmpFolder=REPLACE_BASE_DIR/vfunction/opt/vfunction/agent/instances/REPLACE_INSTANCE/temp/ -Dcom.vfunction.logging.logFile=REPLACE_BASE_DIR/vfunction/var/log/vfunction/instances/REPLACE_INSTANCE/vfagent.log -Xshareclasses:none -Djavax.management.builder.initial= -Djava8.util.Spliterators.assume.oracle.collections.impl=false

Updated on 02 Feb 2024