Apache Tomcat Startup Settings

To instrument applications on Apache Tomcat, add the Java Agent JAR location as a Catalina environment, or CATALINA_OPTS variable.

Instrument Apache Tomcat

  1. Open (or create if it doesn't already exist) the setenv.sh (Linux) or setenv.bat (Windows) file.
    For Tomcat 6 and later, you can put the file in the CATALINA_BASE/bin directory. For previous versions of Tomcat, put the file in the CATALINA_HOME/bin directory.
  2. Add the -javaagent argument to the file as a Catalina environment variable, as follows:
    On Linux:
    CODE 
    export CATALINA_OPTS="$CATALINA_OPTS -javaagent:<agent_home>/javaagent.jar"

    Replace <agent_home> with the full path to the Java Agent JAR file.

    For example:
    CODE 
    export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/home/appserver/appagent/javaagent.jar"
    On Windows:
    CODE 
    set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:"Drive:<agent_home>\javaagent.jar"
    For example:
    CODE 
    set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:C:\appagent\javaagent.jar
  3. Restart the application server for the changes to take effect. For more information on running Tomcat as a service, see Setting Properties and Options on Startup.

Instrument Tomcat When Running as a Windows Service

When running Tomcat as a Windows service, add the javaagent argument to your Tomcat startup properties. These instructions apply to Apache Tomcat >= 6.x.

To install the Java agent in Tomcat running as a Windows service:

  1. Ensure that you are using administrator privileges.
  2. Run the Apache tomcat<version>w.exe utility to configure your tomcat service to load the agent (where <version> represents the major version number of the tomcat being instrumented).
    For example:
    CODE 
    tomcat8w //ES//<servicename>
  3. Click the Java tab and in the Java Options add:
    CODE 
    -javaagent:<agent_home>\javaagent.jar
  4. Restart the Tomcat service to have the changes take effect.