[Webinar] Discover key trends and best practices in Kubernetes observability with DevOps expert, Viktor Farcic.Register now
Our recognition in the inaugural Gartner MQ for DEM

Install APM Insight Java Agent in Apache Tomcat 6.x & above


  • Download the latest APM Insight java agent zip file (apminsight-javaagent.zip) here.
  • Extract the zip file to a new directory to find agent jar and its configuration files
  • Open the apminsight.conf file in any text editor and include the following keys:
    license.key=[LICENSE KEY]
    apm.host=http://[HOST]:[PORT]

    Example:

    license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac
    apm.host=http://apm-prod-server:9090

    To learn more about the agent configurations, visit our Configuration Guide page.

  • For Tomcat as non-service installation

    On Windows:
    • Edit <TOMCAT_HOME>\bin\catalina.bat
    • Add the following entry to the top and save the file
    set JAVA_OPTS=%JAVA_OPTS% -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar

    On Linux:
    • Edit <TOMCAT_HOME>/bin/catalina.sh
    • Add the following entry to the top and save the file
    #!/bin/sh
    export JAVA_OPTS="$JAVA_OPTS -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar"
  • For Tomcat as service installation
    • Navigate to Configure Tomcat and click on the JAVA tab.

      Note: If Configure Tomcat is not available or does not appear in the Windows taskbar search, run the tomcatw.exe (version-specific, e.g., tomcat9w.exe, tomcat10w.exe) script from the <TOMCAT_HOME>\bin directory.

    • Add the following entry in the Java Options box:
      -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
      Note: Replace <agent_directory_full_path> with the full directory path where the APM Insight Agent is installed.
    • After adding the entry, click Apply and then OK.

      Configure tomcat Apache Tomcat Properties

    •  Start the Tomcat server. 
Note:
  • You can also configure a secure APM URL. Ensure that the connection is stable and free from certificate-related issues.
    Example: https://apm-prod-server:8443
  • For an Applications Manager failover setup, you can specify multiple hosts in a comma-separated format (supported from Java Agent v6.8), as shown below:
    apm.host=http://apm-prod-server-A:9090, http://apm-prod-server-B:9090

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.
Back to Top