Help APM Add Java Agent Install Java agent on Tomcat

Installing Java Agent in Tomcat Server 8.x and above

Installing Java Agent in Tomcat Server 8.x & above

  1. Extract the zip file to a new directory to find agent jar and its configuration files.
  2. Open apminsight.conf file in any text editor and add license.key value, which can be obtained from Site24x7 APM Insight page. Refer here to fine tune the agent settings.
  3. For Tomcat as non-service installation:
    In Windows, edit <TOMCAT_HOME>\bin\catalina.bat and add the following entry to the top and save the file.
    set JAVA_OPTS=%JAVA_OPTS% -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
    In Linux, edit <TOMCAT_HOME>/bin/catalina.sh and add the following entry to the top and save the file.
    export JAVA_OPTS="$JAVA_OPTS -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar"
  4. For Tomcat as service installation, navigate to Configure Tomcat > JAVA tab and add the entry in Java Options textbox.
    -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
    If you are unable to find the Configure Tomcat app (for the desired Tomcat server) in Windows search, navigate to the Tomcat bin directory and then double-click on the Tomcat<version>w.exe  file.


    Though the above screenshot is for Windows installation, all the steps given are applicable for Linux installation as well.
  5. After adding the entry, click Apply.
  6. Start the Tomcat server.

Video

Here's a quick video on how to install a Site24x7 APM Insight Java agent in Tomcat Server (8.x and above) on Linux.

Was this document helpful?
Thanks for taking the time to share your feedback. We’ll use your feedback to improve our online help resources.

Help APM Add Java Agent Install Java agent on Tomcat