After you install an Application Real-Time Monitoring Service (ARMS) agent for a Java application, ARMS starts to monitor the Java application. Then, you can view the monitoring data of the Java application, such as the application topology, traces, abnormal transactions, slow transactions, and SQL analysis. You can install an ARMS agent manually or by using scripts. This topic shows you how to manually install an ARMS agent for a Java application.
Prerequisites
- Ensure that the security group of the ECS instance that you use has the TCP outbound
permission on the 8442, 8443, 8883, 9092, and 9093 ports. For more information about
how to enable outbound permissions for ECS instances, see Add a security group rule.
Note ARMS can access not only applications on the ECS, but also applications on other servers that can access the Internet.
- Make sure the third-party components or frameworks that your application uses are supported by ARMS. For more information about the compatibility list, see Supported components and frameworks.
- Check the version of the Java Development Kit (JDK). ARMS supports the following JDK
versions:
- JDK 1.7.0+
- JDK 1.8.0_25+
Note
- If you deploy applications in Kubernetes clusters, we recommend that you use JDK V1.8.0_191 or later.
- Make sure that the JDK version is not 1.8.0_25 or 1.8.0_31. Otherwise, the ARMS agent may fail to be installed. In this case, we recommend that you upgrade JDK to the latest 1.8.X.
- JDK 11.0.8+
Note JDK versions 1.8 and later have different probe installation packages than JDK versions 11. Download the corresponding probe installation packages or adjust the configurations of application monitoring component ack-onepilot based on different JDK versions.
Procedure
- Install the ARMS agent.
- Add the AppName and LicenseKey parameters.
Note Replace{LicenseKey}in the sample code with the license key obtained in the STEP2 section. Replace{AppName}with your application name. The application name cannot contain Chinese characters. Replace{user.workspace}with the directory where the ARMS agent is decompressed. Replace demoApp.jar with the path to the actual JAR package.- Method 1: Edit the JVM parameters based on the runtime environment of your application.
Runtime environment Procedure Tomcat on Linux or macOS Append the following configurations to the {TOMCAT_HOME}/bin/setenv.sh file:
JAVA_OPTS="$JAVA_OPTS -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} "If your Tomcat does not contain the setenv.sh configuration file, open the {TOMCAT_HOME}/bin/catalina.sh file and append the preceding configurations to the JAVA_OPTS parameter. For more information, see Row 256 in the catalina.sh file.
Tomcat on Windows Append the following configurations to the {TOMCAT_HOME}/bin/catalina.bat file: set "JAVA_OPTS=%JAVA_OPTS% -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName}"If the preceding setting does not take effect, append the following configurations to the {TOMCAT_HOME}/bin/catalina.bat file:
set "CATALINA_OPTS=-javaagent:/{user.workspace}/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName}"Jetty Append the following configurations to the {JETTY_HOME}/start.ini configuration file:
--exec -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName}Spring Boot When you start the Spring Boot process, append the -javaagent parameter to the startup command:
java -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} -jar demoApp.jarResin When you start the Resin process, append the following tag to the conf/resion.xml configuration file:
<server-default> <jvm-arg>-javaagent:{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar</jvm-arg> <jvm-arg>-Darms.licenseKey={LicenseKey}</jvm-arg> <jvm-arg>-Darms.appName={AppName}</jvm-arg> </server-default>Append the following tag to the conf/app-default.xml file:
<library-loader path="{user.workspace}/ArmsAgent/plugin"/>Windows When you run a CMD command to start the Java process, use a backslash (\) as the delimiter in the mount path of the ARMS agent.
java -javaagent:\{user.workspace}\ArmsAgent\arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} -jar {user.workspace}\demoApp.jarTo deploy multiple instances of the same application on a server, you can differentiate the JVM processes by setting the -Darms.agentId parameter to a logical number. Example:
java -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} -Darms.agentId=001 -jar demoApp.jar - Method 2: Append the following configurations to the arms-agent.config file:
arms.licenseKey={LicenseKey} arms.appName={AppName}
- Method 1: Edit the JVM parameters based on the runtime environment of your application.
- Add the AppName and LicenseKey parameters.
Verify the result
After about 1 minute, if your application is displayed on the Applications page and some data records are sent, your application is monitored by ARMS.
Uninstall the ARMS agent
If you no longer need to monitor your Java application by using ARMS, perform the following steps to uninstall the ARMS agent.
- Delete all parameters that you added in Step 7, such as {AppName} and {LicenseKey}.
- Restart the Java application.
Change the application name
If you forget to change the sample name Java-Demo to a custom name, you can change the application name without the need to restart the application or reinstall the ARMS agent. For more information, see How do I change the name of a common Java application on which an ARMS agent is manually installed?