接入ARMS的Java应用如何更改应用名称

概述

本文主要介绍接入ARMS的Java应用如何更改应用名称。

详细信息

以通用方式安装Agent的普通Java应用

普通Java应用是指除了部署在阿里云ECS实例上的应用以外的Java应用。如果您是以通用方式安装Agent的，则Agent目录就是您自定义的位置。您可以在Agent目录的Version文件中查看Agent版本。例如，2.5.8_cf020486_20190816150025表示Agent版本为2.5.8，Agent发布时间为2019年8月16日。

如果您的Agent版本低于2.5.8.1，请先卸载Agent再重新安装，并在重新安装时使用新的应用名称。
- 如何卸载Agent，请参见接入ARMS的Java应用和PHP应用如何卸载Agent。
- 如何安装Agent，请参见以下方案：
  - 手动方式：请参见为Java应用手动安装Agent。
  - 脚本方式：请参见使用脚本为Java应用快速安装探针。
如果您的Agent版本为2.5.8.1或以上版本，则可在不重装Agent的情况下更改Java应用名称，请参见以下操作步骤：

说明：2019年8月20日之后下载的Agent默认都支持该功能。
1. 请使用以下方法，下载并解压Supervisor。
  
  说明：请根据您的应用所在的地域替换下载地址中的地域。
  - 公网地址
```
wget http://arms-apm-hangzhou.oss-cn-hangzhou.aliyuncs.com/ArmsSupervisor.zip -O ArmsSupervisor.zip
unzip ArmsSupervisor.zip
```
  - VPC地址（公网地址无法下载时使用）
```
wget http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/ArmsSupervisor.zip -O ArmsSupervisor.zip

unzip ArmsSupervisor.zip
```
2. 依次执行以下命令，更改应用名称。
```
cd ArmsSupervisor
./attach.sh [$Path] [$PID] [$NewAppName] [$LicenseKey]
```
  说明：
  - [$Path]：指向Agent下同名文件的路径，如/path/to/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar。
  - [$PID]：目标进程ID，可通过jps/ps命令获取。
  - [$NewAppName]：新的应用名称。
  - [$LicenseKey]：ARMS应用监控中应用的LicenseKey，可从控制台获取。
  如果应用的标准输出打印以下日志，则说明应用名称更改成功。

以快速方式安装Agent的普通Java应用

如果您是以快速方式安装Agent的，则Agent目录为~/.arms/supervisor/agent，请按照以下步骤更改应用名称。

注意：使用的账号必须与应用相同。

登录应用所在的机器，并依次执行以下命令。
```
cd ~/.arms/supervisor
./cli.sh [$LicenseKey] [$NewAppName]
```
从程序列出的所有Java进程中选择正确的进程。

说明：如果只有一个应用进程则默认选中该进程。
打开~/.arms/attach.info文件，将需要修改的旧应用名称修改为新应用名称并保存文件。

警告：修改文件时切勿多加空格等内容，否则会因为与前述步骤中修改的新应用名称不符而导致修改失败。
应用名称更改成功后稍等片刻，旧名称的应用下将不再有监控数据上报，且新名称的应用下将有监控数据上报。

部署在ECS实例中的Java应用

如果是部署在ECS实例中的Java应用，则Agent目录为/.arms/agent，请按照以下步骤更改应用名称。

登录应用所在的机器，并使用root账号运行以下命令。

su [$USER] -c "./attach.sh /.arms/agent/arms-bootstrap-1.7.0-SNAPSHOT.jar [$PID] [$NewAppName] [$LicenseKey]"

说明：[$USER]为账号，如admin。

打开~/.arms/attach.info文件，将需要修改的旧应用名称修改为新应用名称并保存文件。

警告：修改文件时切勿多加空格等内容，否则会因为与前述步骤中修改的新应用名称不符而导致修改失败。
如果应用的标准输出打印以下日志，则说明应用名称更改成功。

部署在容器服务K8s集群中的Java应用

您可以在Agent目录的Version文件中查看Agent版本。例如，2.5.8_cf020486_20190816150025表示Agent版本为2.5.8，Agent发布时间为2019年8月16日。

如果您的Agent版本低于2.5.8.1，请先卸载Agent再重新安装，并在重新安装时使用新的应用名称。
- 手动安装的Agent的卸载方法，请参见如何卸载以通用方式安装的Agent。
- 以脚本自动安装的Agent的卸载方法，请参见如何卸载以快速方式安装的Agent。
- ECS应用的Agent卸载方法，请参见如何卸载ECS中Java应用的Agent。
如果您的Agent版本为2.5.8.1或以上版本，则可在不重装Agent的情况下更改Java应用名称，请参见以下操作步骤：
说明：2019年8月20日之后下载的Agent默认都支持该功能。
修改Deployment内的armsPilotCreateAppName参数并重启Pod即可。应用名称更改成功后稍等片刻，旧名称的应用下将不再有监控数据上报，且新名称的应用下将有监控数据上报。

部署在EDAS上的Java应用

目前不支持为部署在EDAS上的Java应用更改应用名称。

适用于

应用实时监控服务ARMS