How to instrument the Service Desk Apache Tomcat Agent

Document ID : KB000018526
Last Modified Date : 12/03/2018
Show Technical Document Details
Introduction:

Description:

This Document describes how to configure the Java Agent in the Apache Tomcat instance that is included with CA Service Desk.

Solution:

The Apache Tomcat instance that is provided with CA Service Desk does not use the standard startup scripts as described in the Java Agent Implementation Guide chapter 2 in the section "Configure Apache Tomcat to use the Java agent", therefore a different procedure is required.

There are two published Technical Documents, TEC491277 and TEC598584, that deal with how to change threads or heap parameters for the Service Desk Tomcat instance. The same principal needs to be adopted to add the java agent.

In summary, you must edit Service Desk configuration file, nx.env and look for the @NX_JAVA_OPTIONS token as below:

@NX_JAVA_OPTIONS=-Djava.net.preferIPv4Stack=false -Xms64M -Xmx512M

Change this parameter to include the Java Agent options:

@NX_JAVA_OPTIONS=-Djava.net.preferIPv4Stack=false -javaagent:<PathToAgent.Jar> -Dcom.wily.introscope.agentProfile=<PathToAgent.Profile> -Xms64M -Xmx512M

For example:

@NX_JAVA_OPTIONS=-Djava.net.preferIPv4Stack=false -javaagent:C:\CA\APM\wily\Agent.jar -Dcom.wily.introscope.agentProfile=C:\CA\APM\wily\core\config\IntroscopeAgent.profile -Xms64M -Xmx512M

NOTE: The Java Agent arguments must be placed before the heap size parameters (-Xms -Xmx) or they will be ignored by the Service Desk process that parses this configuration file.

Instructions:
Please Update This Required Field