为 Java 应用手动安装探针_开始监控（通用方式）_开始监控 Java 应用_应用监控

为 Java 应用安装 ARMS 探针后，ARMS 即可对 Java 应用进行应用拓扑、调用链路追踪、异常事务和慢事务监控、SQL 分析等一系列监控。安装探针可采用手动接入方式和一键接入方式。本文将介绍如何为 Java 应用手动安装探针。

前提条件

确保您使用的公网服务器安全组已开放 8442、8443、8883 三个端口的 TCP 公网出方向权限，VPC 内不需要开通。为阿里云 ECS 开放出方向权限，请参见添加安全组规则。

说明 ARMS 不仅可接入阿里云 ECS 上的应用，还能接入其他能访问公网的服务器上的应用。
确保您使用的第三方组件或框架在应用监控兼容性列表范围内，请参见应用监控兼容性列表。

操作步骤

登录 ARMS 控制台。
在左侧导航栏中选择应用监控 > 应用列表。
在应用列表页面顶部选择目标地域，在右上角单击接入应用。
在接入应用页面选择使用语言为 Java，选择使用环境为默认，选择接入方式为手动安装。

采用以下方法之一下载探针，然后在控制台下载探针页签中单击下一步。

方法一：手动下载。在下载探针页签中单击下载探针按钮，下载最新 ZIP 包。

方法二：Wget 命令下载。根据您的地域使用 Wget 命令下载对应的探针压缩包。

# 杭州地域
wget "http://arms-apm-hangzhou.oss-cn-hangzhou.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 上海地域
wget "http://arms-apm-shanghai.oss-cn-shanghai.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 青岛地域
wget "http://arms-apm-qingdao.oss-cn-qingdao.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 北京地域
wget "http://arms-apm-beijing.oss-cn-beijing.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 张家口地域
wget "http://arms-apm-zhangjiakou.oss-cn-zhangjiakou.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 深圳地域
wget "http://arms-apm-shenzhen.oss-cn-shenzhen.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
# 新加坡地域
wget "http://arms-apm-ap-southeast.oss-ap-southeast-1.aliyuncs.com/cloud_ap-southeast-1/ArmsAgent.zip" -O ArmsAgent.zip
# 金融云环境
wget "http://arms-apm-hangzhou.oss-cn-hangzhou.aliyuncs.com/finance/ArmsAgent.zip" -O ArmsAgent.zip

切换到探针安装包所在目录，并执行以下命令解压安装包到任意工作目录下。
```
unzip ArmsAgent.zip -d /{user.workspace}/ 
```
说明 {user.workspace} 是示例目录。
在安装探针页签中查看并保存 LicenseKey。
采用以下方法之一添加 AppName 以及 LicenseKey 参数。
- 方法一：根据您的应用运行环境修改 JVM 参数。
  
  说明将 <LicenseKey> 替换成您的 LicenseKey；将 <AppName> 替换成您的应用名称，应用名暂不支持中文；将{user.workspace} 替换成实际探针解压的目录。
  - Tomcat 运行环境
    - 在 Linux 或 Mac 环境下，请在 {TOMCAT_HOME}/bin 目录下的 setenv.sh 文件中加入以下配置。
      
      说明
      如果您的 Tomcat 版本没有 setenv.sh 配置文件，请打开 {TOMCAT_HOME}/bin/catalina.sh 文件，找到 JAVA_OPTS 变量定义，并在该变量定义后加入以下配置。
      
      下载参考样例：catalina.sh（第 256 行定义）。
```
JAVA_OPTS="$JAVA_OPTS -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName>" 
```
    - 在 Windows 环境下，请在 {TOMCAT_HOME}/bin/catalina.bat 文件中加入以下配置：
```
set "JAVA_OPTS=%JAVA_OPTS% -javaagent:{user.workspace}ArmsAgentarms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName>" 
```
      说明如果以上配置未生效，可以尝试在 {TOMCAT_HOME}/bin/catalina.bat 文件中再添加以下配置：
      set "CATALINA_OPTS=-javaagent:{user.workspace}arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName>"
  - Jetty 运行环境
    
    在 {JETTY_HOME}/start.ini 配置文件中加入以下配置：
```
--exec #打开注释 前面的井号去掉即可 -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName> 
```
  - Spring Boot 运行环境
    
    启动 Spring Boot 进程时，在启动命令后面加上 -javaagent 参数：
```
java -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName> -jar demoApp.jar 
```
    说明 demoApp.jar 为原应用 JAR 包名称，请根据实际情况替换。
  - Resin 运行环境
    1. 启动 Resin 进程时，需要在 conf/resion.xml 配置文件中添加以下标签：
```
<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-xxxarg> </server-default> 
```
    2. 在 conf/app-default.xml 文件中添加以下标签：
```
<library-loader path="{user.workspace}/ArmsAgent/plugin"/> 
```
  - Windows 运行环境
    
    在 Windows 环境下启动 Java 进程时，请在挂载探针路径中使用反斜杠作为分隔符。
```
{CMD}> java -javaagent:{user.workspace}ArmsAgentarms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName> -jar {user.workspace}demoApp.jar 
```
    说明 demoApp.jar 为原应用 JAR 包名称，请根据实际情况替换。
  同一台机器上面，部署同一应用的多个实例场景，可以通过 -Darms.agentId（逻辑编号：如 001，002）参数来区分接入的 JVM 进程，例如：
```
    java -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=<LicenseKey> -Darms.appName=<AppName> 
    -Darms.agentId=001 -jar demoApp.jar
```
- 方法二：
  1. 修改 arms-agent.config 文件。将 <LicenseKey> 替换成您的 LicenseKey；将 <AppName> 替换成您的应用名称，应用名暂不支持中文字符。
```
arms.licenseKey=<LicenseKey> arms.appName=<AppName>
```
  2. 修改 JVM 参数，在 Java 应用的启动脚本中添加以下参数。
```
-javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar 
```
    说明将 {user.workspace} 替换成实际探针解压的目录。
重启 Java 应用。

结果验证

约一分钟后，若 Java 应用出现在应用列表中且有数据上报，则说明接入成功。

卸载探针

当您不需要使用 ARMS 监控您的 Java 应用时，删除上述安装文档中的步骤 8 添加的 AppName、LicenseKey 相关的所有参数。
重启 Java 应用。

快速更改应用名称

如果因为某些原因希望更改应用名称，例如忘记将示例应用名称 Java-Demo 修改为自定义名称，您可以在不重启应用、不重装探针的情况下更改应用名称，详情参见普通 Java 应用（以普通方式安装探针时）。

为 Java 应用手动安装探针

前提条件

操作步骤

结果验证

卸载探针

快速更改应用名称

更多信息

开始监控：按应用部署环境

EDAS

ECS 实例

阿里云容器服务 K8s 集群

开源 K8s 集群

Docker 集群

其他环境（如自建 IDC）

开始监控：按应用语言

开始监控 Java 应用

开始监控 PHP 应用

开始监控 Go 应用 *

开始监控 Node.js 应用 *

开始监控 .NET 应用 *

开始监控 C++ 应用 *