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

  • Download latest the 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 to JAVA tab
    • Add the below entry in 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