Install APM Insight Java Agent in JBoss EAP 6.2.x & above


Note: The application server user must have access to the agent-installed folder.

    • 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.
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
  • For the Standalone setup:
    • Edit the <JBOSS_HOME>/bin/standalone.conf file (standalone.conf in Linux and standalone.conf.bat in Windows) and add the specified Java arguments to the existing JAVA_OPTS.
    • From Java Agent v6.6.1:
      -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
-Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine -javaagent:<agent_directory_full_path>/apminsight-javaagent.jar
    • For the Domain setup:
      • Edit the <JBOSS_HOME>/domain/configuration/Host.xml file and locate <servers> tag and add the mentioned tags under your desired<server name="your_server" ...> tag.
        <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 EAP server
      • From Java Agent v6.6.1:
        <jvm name="insight">
        <jvm-options>
        <option value="-javaagent:<agent_directory_full_path>/apminsight-javaagent.jar" />
        </jvm-options>
        </jvm>

Learn more about Applications Manager's JBoss Monitoring.

Installing Java Agent in JBoss EAP through Management Console

For version 6.2.x

Note: System Properties option is not required from Java agent v6.6.1

Open the management console through localhost:9990/console and login as “Management Realm” user.

  • Select Hosts tab → Server ConfigurationsServer instance in which you like to install the agent → JVM Configuration tabAdmin Console
  • Click on Edit button to create a JVM Configuration for the server. In JVM options text box, add the following lines (each JVM option must be separated by a new line)
-javaagent:AGENT_HOME/apminsight-javaagent.jar
  • Click on save button, you will see “Added/Modified JVM Config” message at top of the page. If the message doesn't appear, check your configuration carefully and save it again.
  • Now, select “System Properties” tab and Click “Add” button.
Admin Console
  • In the newly opened dialog box, fill in the following values:
Name : jboss.modules.system.pkgs
Value : org.jboss.byteman,com.manageengine
Boot-Time : Check
  • And click “Save” button.
  • Finally, start/restart your configured server instance from “Runtime” tab at top left corner of the page.

For version 7.x

Note: System Properties option is not required from Java agent v6.6.1

Open the management console through localhost:9990/console and login as “Management Realm” user.

  • Select Runtime tab → Hosts → Choose the Host followed by the Server instance in which you like to install the agent → Click View to view the Server configuration.Admin Console
  • Click on Edit button to create a JVM Configuration for the server. In JVM options text box, add the following lines (each JVM option must be separated by a new line)
-javaagent:AGENT_HOME/apminsight-javaagent.jar
  • Click on save button, you will see “Added/Modified JVM Config” message at top of the page. If the message doesn't appear, check your configuration carefully and save it again.
  • Now, select “System Properties” tab and click “Add” button.
Admin Console
  • In the newly opened dialog box, fill in the following values:
Name : jboss.modules.system.pkgs
Value : org.jboss.byteman,com.manageengine
Boot-Time : Check
  • And click “Save” button.
  • Finally, start/restart your configured server instance from “Runtime” tab at top left corner of the page.

Note: The same steps can be followed if JBoss EAP is running on JRE versions 1.6 to 22.