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: 
    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:
    export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/home/appserver/appagent/javaagent.jar"
    On Windows: 
    set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:"Drive:<agent_home>\javaagent.jar"
    For example:
    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.