5 Install and Configure APM Java Agent on JBoss
Here are the requirements and instructions to install APM Java Agent on JBoss.
JBoss: Requirements and Installation Instructions
Prerequisites for Deploying APM Java Agent on a JBoss Server
-
Supported versions:
-
JBoss EAP 6.1.1+
-
Wildfly 9.0.2
-
-
JDK version 1.7 or above. If you are using JDK 1.6, either use a JDK 1.6 that supports TLS 1.2 security protocol, or connect to OMC through a Gateway.
-
If the JDK version you are running doesn't support TLS 1.2 security protocol, refer to My Oracle Support Doc ID 2703411.1 before proceeding with the APM agent installation.
-
Other considerations:
-
The machine hosting the JBoss Server should be able to establish an HTTPS connection either directly or indirectly (using a proxy server or an Oracle Management Cloud gateway) to Oracle Management Cloud. For more information about Oracle Management Cloud gateway, see Install a Gateway.
-
The HTTPS connection must use TLS 1.2 security protocol.
-
The install user of APM Java Agent should be the same as the JBoss user.
-
The JBoss Server user should have read and write permissions to the directories that host the APM Java Agent, as well as the JBOSS Home.
-
Set the JBOSS_HOME
Variable
Set the JBOSS_HOME
variable to point to the JBoss home directory.
-
If you're using a Bash shell:
export JBOSS_HOME=<JBoss home directory>
-
If you're using a C shell:
setenv JBOSS_HOME "<JBoss home directory>"
Deploy a Gateway (Optional)
-
If you have an application server that does not support Transport Layer Security (TLS) protocol 1.2
-
If you have older versions of Java Application Servers with JDK less than 1.7 (for example, Oracle WebLogic 10.3.6)
Set the Gateway Variables (Optional)
Set the values for Gateway host and port.
-
If you're using a Bash shell:
export GW_HOST=<Gateway Host Name> export GW_PORT=<Gateway Port>
-
If you're using a C shell:
setenv GW_HOST "<Gateway Host Name>" setenv GW_PORT "<Gateway Port>"
If you are using more than one gateway, use the -additional-gateways
option with the provisioning script.
Download the APM Java Agent Software for JBoss
-
On the Oracle Management Cloud home page, click the Oracle Management Cloud Navigation icon on the top-left corner to view the Management Cloud navigation pane.
-
Select Administration and Agents.
-
On the Oracle Management Cloud Agents page, click the Action Menu on the top right corner of the page and select Download Agents.
The Agent Software Download page is displayed.
-
From the Agent Type dropdown list, select APM Agent.
-
Click APM Java Agent.
-
Extract the contents of the installer ZIP file.
-
Create a registration key that will be used during the time of installing a new agent. Oracle Application Performance Monitoring Cloud Service verifies this key before accepting any data sent by APM Java Agent deployed on your on-premises hosts. For more information about creating a registration key, see Manage Registration Keys in Installing and Managing Oracle Management Cloud Agents.
Install and Provision APM Java Agent on JBoss
-
Before you install the APM Java Agent, log in to the machine running the application server as a user who installed the application server.
-
The application server user should have Read-Write access to the APM Java Agent directories.
You can install and provision the APM Java Agent from an offline installer that you have received over email.
To install from the emailed ZIP, the provisioning script needs to download the configuration file from Oracle Management Cloud. Specify these additional options while running the provisioning script:
Option | Description |
---|---|
-tenant-id |
The Oracle Management Cloud tenant name. |
-omc-server-url |
The URL of the Oracle Management Cloud server. Example: https://omchost:port |
Modify the Startup Script of Your JBoss Server
Modify the startup script of your application server to invoke Oracle Application Performance Monitoring, when you start your JBoss/WildFly server.
standalone.conf
script of your JBoss/WildFly server:
Install and Provision APM Java Agent on JBoss on Microsoft Windows
You can install and provision the APM Java Agent on your JBoss domain installed on a Microsoft Windows machine.
Before you install:
-
Log in to the machine running the application server, as the same user who installed the application server.
-
Ensure that the application server user has Read-Write access to the APM Java Agent directories.
-
Run the following command to provision the APM Java Agent:
set the DOMAIN HOME : set JBOSS_HOME=<JBoss_Home Path> ProvisionApmJavaAsAgent.cmd /d %JBOSS_HOME% /no-wallet
-
Provision the APM Java agent. This enables the APM Agent to be invoked when you restart the JBoss Server.
-
Make a backup copy of your
standalone.conf.bat
file:%cd %JBOSS_HOME%\bin %cp standalone.conf.bat standalone.conf.bat.orig
-
-
Edit the standalone.conf.bat file, add the following lines at the end of the file:
set "JAVA_OPTS=%JAVA_OPTS% -Djboss.modules.system.pkgs=org.jboss.byteman,oracle.security.pki,oracle.apmaas.agent,oracle.apmaas.repackaged" set "JAVA_OPTS=%JAVA_OPTS% -javaagent:%JBOSS_HOME%\apmagent\lib\system\ApmAgentInstrumentation.jar"
-
Stop and restart the JBoss Server:
You can check the entries present in the% cd <JBOSS_HOME>\bin % ./standalone.conf.bat -b 0.0.0.0
<JBOSS_HOME>\startup.log
file to verify that the JBoss Server has started. -
If you have any managed JBoss application servers, stop and restart them.