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. This topic describes how to manually install an ARMS agent for a Java application.
For applications deployed in Container Service for Kubernetes (ACK) clusters, we recommend that you install the ack-onepilot component rather than manually install an ARMS agent. For more information, see Automatically install an ARMS agent in ACK and Automatically install an ARMS agent in an open source Kubernetes cluster.
Prerequisites
The network configurations meet the requirements. For more information, see Network configurations required by the ARMS agent for Java.
The version of the JDK is supported by Application Monitoring. For more information, see Java components and frameworks supported by ARMS.
The maximum heap memory of the process is greater than 256 MB.
Install an ARMS agent
Log on to the ARMS console. In the left-side navigation pane, click Integration Center.
Click the Java Application Monitor card. In the panel that appears, select Manual Installation.
Download an ARMS agent.
Method 1: Manually download an ARMS agent. In the Java Application Monitor panel, download an ARMS agent as prompted.
Method 2: Run the wget command. Download the installation package based on your region.
Decompress the installation package.
Go to the directory of the installation package. Run the following command to decompress the installation package to a working directory:
unzip AliyunJavaAgent.zip -d /{user.workspace}/Note{user.workspace} is a sample directory. Replace the sample directory with the actual directory.
Add the AppName and LicenseKey parameters.
Obtain a license key in the Java Application Monitor panel. AppName specifies the application that is integrated into ARMS. Enter a custom application name based on your needs. In a distributed architecture, an application can contain multiple peer application instances.
Use one of the following methods to add the AppName and LicenseKey parameters.
Method 1: Replace the
{LicenseKey}parameter with the license key obtained from the console and replace the{AppName}parameter with the application name.Method 2: Do not specify the LicenseKey and AppName parameters in the script. Add the following configurations to the arms-agent.config file of the installation package.
arms.licenseKey={LicenseKey} arms.appName={AppName}
Add the integration command to the startup command.
Replace
{user.workspace}with the directory to which the ARMS agent is decompressed. Replace demoApp.jar with the path to the actual JAR package.NoteIf you use an ARMS agent earlier than 2.7.3.5, replace AliyunJavaAgent/aliyun-java-agent.jar in the preceding code with ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar. We recommend that you upgrade the agent to the latest version at the earliest opportunity.
In Windows, replace
/in the script with\and replace the.shfile with the.batfile.The ARMS agent V2.7.1.4 allows you to activate Application Security when you connect your application to Application Monitoring. If you need to activate Application Security, add
-Darms.appsec.enable=truein the script. For information about the billing rules of Application Security, see Billing rules.
Runtime environment
Procedure
Spring Boot applications or other Java applications started by running the
java -jarcommandAdd the -javaagent option to the startup command. Make sure that the -javaagent parameter is written before the -jar parameter.
java -javaagent:/{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} -jar demoApp.jarTomcat
Add the following configurations to the {TOMCAT_HOME}/bin/setenv.sh file:
JAVA_OPTS="$JAVA_OPTS -javaagent:/{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} "If your Tomcat service 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.
Jetty
Append the following configurations to the {JETTY_HOME}/start.ini configuration file:
aliyun-java-agent.jar --exec -javaagent:/{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName}Resin
When you start the Resin process, append the following tag to
conf/resin.xmlorconf/resin.conf:
<server-default> <jvm-arg>-javaagent:{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar</jvm-arg> <jvm-arg>-Darms.licenseKey={LicenseKey}</jvm-arg> <jvm-arg>-Darms.appName={AppName}</jvm-arg> </server-default>If
conf/resin.propertiesis used, append the following tag to the file:jvm_args : -javaagent:{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName}Append the following tag to the conf/app-default.xml file:
<library-loader path="{user.workspace}/AliyunJavaAgent/plugin"/>To deploy multiple instances of the same application on a server, set the -Darms.agentId parameter to a logical number to differentiate the JVM processes. Example:
java -javaagent:/{user.workspace}/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey={LicenseKey} -Darms.appName={AppName} -Darms.agentId=001 -jar demoApp.jarRestart the Java application.
(Optional) Sample Dockerfile
For a Docker environment, you can refer to the following sample Dockerfile to install an ARMS agent.
# Replace {original-docker-image:tag} with your image address.
FROM {original-docker-image:tag}
# Replace the working directory based on your business requirements.
WORKDIR /root/
# Obtain the public endpoint or virtual private cloud (VPC) where you can download the installation package of the ARMS agent in the desired region. For more information, see Step 4 of the "Install an ARMS agent" section.
RUN wget "http://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/AliyunJavaAgent.zip" -O AliyunJavaAgent.zip
# Decompress the installation package of the ARMS agent.
RUN unzip AliyunJavaAgent.zip -d /root/
# Write the LicenseKey and AppName parameters to environment variables. For more information, see Step 6 of the "Install an ARMS agent" section.
ENV arms_licenseKey={LicenseKey}
ENV arms_appName={AppName}
# Add the startup script to the JAVA_TOOL_OPTIONS environment variables.
ENV JAVA_TOOL_OPTIONS ${JAVA_TOOL_OPTIONS} '-javaagent:/root/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey='${arms_licenseKey}' -Darms.appName='${arms_appName}
### Check the JAVA_TOOL_OPTIONS environment variables.
RUN env | grep JAVA_TOOL_OPTIONS
### Add custom Dockerfile logic.
### ......Verify the result
After about 1 minute, choose . If your application is displayed on the Application List page and some data records are sent, your application is monitored by ARMS.