[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 JBoss AS 4.2.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 configurations, visit our Configuration Guide page.
  • For JBoss AS 4.x, 5.x, 6.x servers:
    • For Windows, open <JBOSS_HOME>\bin\run.bat in any text editor and add the following entry at the top and save it.
    set JAVA_OPTS=-javaagent:<agent_directory_full_path>/apminsight-javaagent.jar %JAVA_OPTS%
    • For Linux, open <JBOSS_HOME>/bin/run.sh in any text editor and add the following entry at the top and save it.
    #!/bin/sh
    export JAVA_OPTS="$JAVA_OPTS -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar"
  • For JBoss AS 7.x servers:
      • In standalone setup: Edit the <JBOSS_HOME>/bin/standalone.bat (In Linux, standalone.sh) file to add the following java arguments to the existing JAVA_OPTS.
    -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
      • In domain setup: Edit <JBOSS_HOME>/domain/configuration/Host.xml file and locate <servers> tag and add the mentioned tags under your desired .
    <system-properties>
    <property name="jboss.modules.system.pkgs" value="org.jboss.byteman,com.manageengine" boot-time="true"/>
    </system-properties>
    <jvm name="insight">
    <jvm-options>
    <option value="-javaagent:<agent_directory_full_path>/apminsight-javaagent.jar" />
    </jvm-options>
    </jvm>
    • Save the file and start the JBoss Application Server
Note:
  • The application server user must have access to the agent-installed folder.
  • There is a bug in JBoss AS 7.2.x with a hindrance to deploy our APM Insight Java Agent in this server. We suggest to upgrade the JBoss server and try installing APMInsight Agent.
  • 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

Learn more about Applications Manager's JBoss monitoring.

Back to Top