全部产品
阿里云办公

手动接入普通应用

更新时间:2018-12-03 14:00:09

本文介绍了如何快速接入 ARMS 应用监控平台。如为 EDAS 场景,请参考一键接入 EDAS 应用

手动接入普通应用

  1. 登录 ARMS 控制台,在左侧导航栏中选择应用监控 > 应用列表

  2. 在页面右上角或中心单击新接入应用

  3. 在弹出对话框中填写应用名称,并单击确定。此时会跳转到应用设置页面。

    Application Settings Page

  4. 采用以下方法之一下载 Java 探针。

    • 方法1:直接下载。单击点击下载按钮,下载最新 ZIP 包。
    • 方法2:wget 命令下载。使用 wget 命令下载 Agent 压缩包。(请根据地域下载对应的压缩包。)

      1. # 杭州地域
      2. wget "http://arms-apm-hangzhou.oss-cn-hangzhou.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
      3. # 上海地域
      4. wget "http://arms-apm-shanghai.oss-cn-shanghai.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
      5. # 青岛地域
      6. wget "http://arms-apm-qingdao.oss-cn-qingdao.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
      7. # 北京地域
      8. wget "http://arms-apm-beijing.oss-cn-beijing.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
      9. # 深圳地域
      10. wget "http://arms-apm-shenzhen.oss-cn-shenzhen.aliyuncs.com/ArmsAgent.zip" -O ArmsAgent.zip
      11. # 新加坡地域
      12. wget "http://arms-apm-ap-southeast.oss-ap-southeast-1.aliyuncs.com/cloud_ap-southeast-1/ArmsAgent.zip" -O ArmsAgent.zip
      13. # 金融云环境
      14. wget "http://arms-apm-hangzhou.oss-cn-hangzhou.aliyuncs.com/finance/ArmsAgent.zip" -O ArmsAgent.zip
  5. 解压并部署探针包。

    1. 切换到 ArmsAgent 探针包所在目录,解压到任意工作目录下。
    2. 在应用设置的安装探针页面查看 arms.licenseKey 和 arms.appId 属性。

      Install Probe Page

    3. 在 Java 启动参数中加入 -javaagent 参数,指向探针包中 arms-bootstrap-1.7.0-SNAPSHOT.jar 文件,并在参数后加上 -Darms.licenseKey=xxx 和 -Darms.appId=xxx 参数。

    注意事项

    • 挂载 Agent 后应用启动时报 OutOfMemoryError 错误

      如出现此情况,请在 Java 启动命令后面加上堆内存大小配置项,以适量调大 JVM 参数。

      以堆内存初始值(Xms)512 M、堆内存最大值(Xmx)2 G 为例,配置项如下所示。请根据实际情况适量调节。对于 Tomcat 等其他环境,请在配置文件的 JAVA_OPTS 中加入此参数。

      1. -Xms512M
      2. -Xmx2048M

      如果出现OutOfMemoryError: PermGen space错误,加入参数:

      1. -XX:PermSize=256M
      2. -XX:MaxPermSize=512M

      数值请按实际情况酌情调整,本文仅给出建议值。

    • ECS 环境部署配置

      Agent 部署环境需要保证 TCP 协议在 844284438883 端口的权限畅通。ECS 环境下部署 Agent 需要开放这三个端口的 TCP 公网入方向权限,详细步骤如下。

      1. 在 ARMS 控制台左侧导航栏中选择自定义监控-数据源管理 > 云服务器 ECS。 在云服务器 ECS 页面上找到您的 ECS,并单击 ECS 实例名称跳转到 ECS 控制台。

      2. 在 ECS 控制台左侧导航栏中选择网络和安全 > 安全组。在安全组列表页面单击配置规则

      3. 经典网络环境下,配置公网入方向和公网出方向。专用网络环境下,配置入方向和出方向。入方向加入 844284438883 端口的 TCP 协议权限。出方向默认设置为端口全部打开。

    • Tomcat 运行环境配置

      在 {TOMCAT_HOME}/bin 目录下的 setenv.sh 中加入以下配置。

      注意:如果您的 Tomcat 版本没有 setenv.sh 配置文件,请打开 {TOMCAT_HOME}/bin/catalina.sh,找到 JAVA_OPTS 变量定义,并在该变量定义后加入以下配置。

      点击下载参考样例:catalina.sh(第 256 行定义)

      1. JAVA_OPTS="$JAVA_OPTS -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=xxx -Darms.appId=xxx"

      注意:在 Windows 环境下,请在 {TOMCAT_HOME}/bin/catalina.bat 中加入:

      1. set "JAVA_OPTS=%JAVA_OPTS% -javaagent:{user.workspace}\ArmsAgent\arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=xxx -Darms.appId=xxx"
    • Jetty 运行环境配置

      在 {JETTY_HOME}/start.ini 配置文件中加入以下配置:

      1. --exec #打开注释 前面的井号去掉即可
      2. -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar
      3. -Darms.licenseKey=xxx
      4. -Darms.appId=xxx
    • Spring Boot 运行环境配置

      启动 Spring Boot 进程时,在启动命令 java 后面加上 -javaagent 参数:

      1. java -javaagent:/{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=xxx - Darms.appId=xxx -jar demoApp.jar

      注意:demoApp.jar 为原应用 JAR 包名称,请根据实际情况替换。

    • Resin 运行环境配置

      1. 启动 Resin 进程时,需要在 conf/resion.xml 配置文件中添加以下标签:
        1. <server-default>
        2. <jvm-arg>-javaagent:{user.workspace}/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar</jvm-arg>
        3. <jvm-arg>-Darms.licenseKey=xxx</jvm-arg>
        4. <jvm-arg>-Darms.appId=xxx</jvm-xxxarg>
        5. </server-default>
      2. 在 conf/app-default.xml 中添加以下标签:
        1. <library-loader path="{user.workspace}/ArmsAgent/plugin"/>
    • Windows 运行环境配置

      在 Windows 环境下启动 Java 进程时,请在挂载 Agent 路径中使用反斜杠作为分隔符。

      1. {CMD}> java -javaagent:{user.workspace}\ArmsAgent\arms-bootstrap-1.7.0-SNAPSHOT.jar -Darms.licenseKey=XXX -Darms.appId=XXX
      2. -jar {user.workspace}\demoApp.jar

      注意:licenseKey、appId 为接入应用设置页面上对应的配置值,demoApp.jar 为原应用 JAR 包名称,请根据实际情况替换。

  6. 重启任务,几分钟后 Agent 将自动接入 ARMS 应用监控中。

删除应用

  1. 应用设置页面,单击删除标签页,然后单击删除应用
  2. 在弹出对话框中单击删除来确认。