Configuring the Java Agent on Apache Tomcat for DevTest using CATALINA_OPTS

Products

• Service Virtualization

Issue/Introduction

Tomcat is an unsupported environment.

However, the DevTest agent has been successfully deployed to several Tomcat environments and is working as expected.

Prerequisite: Tomcat must run on a supported OS and java version.
Please see the DevTest documentation for supported OS and java versions.

Ensure Tomcat is running correctly before adding the DevTest agent.

 

Environment

All supported DevTest platforms and releases.

Resolution

Tomcat is highly configurable and the below instructions are for a default Tomcat install.

Adjustments maybe necessary based on your exact configuration.

General:

You can download the DevTest Java Agent files from the DevTest Portal.  NOTE: Refer to section "Download DevTest Java Agent Files" in DevTest documentation for the version you are running.

Insert the agent startup/configuration command at the beginning of the first startup script.

The variable CATALINA_OPTS should be used instead of JAVA_OPTS or JAVA_TOOL_OPTIONS.

From Tomcat documentation:
CATALINA_OPTS   (Optional) Java runtime options used when the "start", "run" or "debug" command is executed.
Include here and not in JAVA_OPTS all options, that should only be used by Tomcat itself, not by the stop process, the version command etc. Examples are heap size, GC logging, JMX ports etc.

The usual startup scripts are:

• Windows: startup.bat
• Unix/Linux: startup.sh

Insert the agent startup/configuration command as the first non-comment line:

set CATALINA_OPTS= -javaagent:<pathTo InsightAgent.jar>=name=<agentName>,url=<connectionToBroker> -Xbootclasspath/a:<pathTo LisaAgent.jar> 
where:

<pathTo InsightAgent.jar> = Complete path to the InsightAgent.jar
<agentName> = Must be a unique name and will be the name used in the portal.
<connectionToBroker> = Connection to broker usually something like: tcp://<RegistryHost>:2009
<pathTo LisaAgent.jar>  = Complete path to the LisaAgent.jar

Example:

set CATALINA_OPTS= -javaagent:/agent/InsightAgent.jar=name=DIGIBANK,url=tcp://<BROKER-HOST>:2009 -Xbootclasspath/a:/agent/LisaAgent.jar

 

To verify the agent is working:

• Restart Tomcat
• In the DevTest Portal (a page refresh maybe needed):  Settings -> Agents
• The agents unique name should appear in the list of agents.

If further assistance is needed, please open a support ticket.