金石原创 |【JVM实战系列】「监控调优体系」实战开发arthas-spring-boot-starter监控你的微服务是否健康!

朴灿烈づ我的快乐病毒、 2023-09-25 18:54 3阅读 0赞

### 前提介绍 ###

相信如果经历了我的上一篇Arthas的文章\[【JVM实战系列】「监控调优体系」针对于Alibaba-Arthas的安装入门及基础使用开发实战指南\]之后，相信你对Arthas的功能和使用应该有了一定的理解了。那么我们就要进行下一步的探索功能。

### Arthas对于SpringBoot2的支持和监控体系 ###

在SpringBoot2应用中加入arthas-spring-boot-starter后，Spring会启动arthas服务，并且进行attach自身进程，并配合tunnel server实现远程管理。这样的方案非常适合在微服务容器环境中进行远程诊断，在容器网络环境中仅需要对外暴露tunnel server的端口。

#### Arthas的监控体系所需要的组件支持 ####

*  Arthas Tunnel Server/Client（Java agent探针的管理和监控，方便我们管理服务和探针）

*  Web Console

#### 什么是Arthas Tunnel ####

在容器化部署的环境内部，Java进程可以是在不同的机器启动的，想要使用Arthas去诊断会比较麻烦，因为用户通常没有机器的权限，即使登陆机器也分不清是哪个Java进程。在这种情况下，可以使用 Arthas Tunnel Server/Client。

##### Arthas Tunnel的作用和目的 #####

整个Arthas的功能体系中，可以通过Arthas Tunnel Server/Client来远程管理/连接多个Agent（也就代表着可以监控多个JVM进程）。主要目的用于监控和获取目标的JVM的进程数据信息。

##### 下载部署Arthas tunnel server #####

###### Github源码仓库下载 ######

[下载地址Arthas tunnel server][Arthas tunnel server]，目前最新版本为arthas-all-3.6.7版本，如下图所示。

![format_png][]

针对于Arthas的安装包进行下载资料进行介绍：

*  arthas-3.6.7.deb：主要用于debian操作系统去运行的安装包

*  arthas-bin.zip：二进制可运行执行包

*  arthas-doc.zip：针对于arthas的文档

*  **arthas-tunnel-server-3.6.7-fatjar.jar**：Arthas tunnel server服务的Jar可以执行包

*  Source code(zip)：源码zip压缩包

*  Source code(tar.gz)：源码tar包

###### Maven仓库下载 ######

阿里云的下载地址：[arthas.aliyun.com/download/ar…][arthas.aliyun.com_download_ar]

##### 直接运行对应的Arthas tunnel server #####

Arthas tunnel server是一个Spring boot fat jar 应用，直接java -jar启动：

java -jar  arthas-tunnel-server.jar
    复制代码

默认情况下，arthas tunnel server的web端口是8080，Arthas agent 连接的端口是7777

![format_png 1][]

打开WebConsole，分别输入Arthas agent的ip(127.0.0.1)和port(7777)，和SpringBoot应用里配置的agent-id(URJZ5L48RPBR2ALI5K4V)，点Connect即可。

###### Web Console ######

如果希望可以通过浏览器连接Arthas服务，此时这里的Arthas服务指的不是Arthas tunnel server，Arthas是总体的服务控制端，发送指令的部分，而Arthas tunnel server属于对接和管理agent的专门服务(依赖于Arthas Spring Boot Starter的服务)。

出了CLI模式之外，Arthas目前支持 Web Console，用户在attach成功之后，可以直接访问：[http://127.0.0.1:8563/。][http_127.0.0.1_8563]可以填入 IP，远程连接其它机器上的arthas。启动之后，可以访问 [http://127.0.0.1:8080/][http_127.0.0.1_8080] ，再通过agentId连接到已注册的arthas agent 上，如下图所示。

![format_png 2][]

通过Spring Boot的Endpoint，可以查看到具体的连接信息： [http://127.0.0.1:8080/actuator/arthas][http_127.0.0.1_8080_actuator_arthas] ，

![format_png 3][]

登陆用户名是arthas，密码在 arthas tunnel server 的日志里可以找到，比如：

![format_png 4][]

> **注意：默认情况下，arthas 只 listen 127.0.0.1，所以如果想从远程连接，则可以使用 --target-ip参数指定 listen 的 IP，更多参考-h的帮助说明。 注意会有安全风险，考虑下面的 tunnel server 的方案。**

#### 如何将服务连接Arthas tunnel server ####

主要有两种模式连接Arthas tunnel server：

1.  远程运行的Arthas server连接Arthas tunnel server

1.  远程运行的Arthas Spring Boot Starter的agent探针服务连接Arthas tunnel server

![format_png 5][]

##### 启动 arthas 时连接到 tunnel server #####

在启动 arthas，可以传递--tunnel-server参数，比如：

as.sh --tunnel-server 'ws://127.0.0.1:7777/ws'复制代码

如果有特殊需求，可以通过--agent-id参数里指定 agentId。默认情况下，会生成随机 ID。attach 成功之后，会打印出 agentId。

,---.  ,------. ,--------.,--.  ,--.  ,---.   ,---.
     /  O  \ |  .--. ''--.  .--'|  '--'  | /  O  \ '   .-'
    |  .-.  ||  '--'.'   |  |   |  .--.  ||  .-.  |`.  `-.
    |  | |  ||  |\  \    |  |   |  |  |  ||  | |  |.-'    |
    `--' `--'`--''--'   `--'   `--'  `--'`--' `--'`-----'
    
    wiki      https://arthas.aliyun.com/doc
    tutorials https://arthas.aliyun.com/doc/arthas-tutorials.html
    version   3.1.2
    pid       86183
    time      2022-11-30 15:40:53
    id        URJZ5L48RPBR2ALI5K4V
    
    复制代码

即使是启动时没有连接到 tunnel server，也可以在后续自动重连成功之后，通过 session 命令来获取 agentId：

[arthas@86183]$ session
     Name           Value
    -----------------------------------------------------
     JAVA_PID       86183
     SESSION_ID     f7273eb5-e7b0-4a00-bc5b-3fe55d741882
     AGENT_ID       URJZ5L48RPBR2ALI5K4V
     TUNNEL_SERVER  ws://127.0.0.1:7777/ws
    复制代码

在浏览器里访问 [http://localhost:8080/arthas，输入agentId，就可以连接到本机/其他机器上上的][http_localhost_8080_arthas_agentId] arthas 了。

###### tunnel server的注意要点 ######

*  agentId要保持唯一，否则会在 tunnel server 上冲突，不能正常工作。

*  如果arthas agent配置了appName，则生成的agentId会带上appName的前缀。

###### 添加对应的app-name参数 ######

###### 启动参数 ######

as.sh --tunnel-server 'ws://127.0.0.1:7777/ws' --app-name demoapp ，则生成的 agentId 可能是demoapp_URJZ5L48RPBR2ALI5K4V。复制代码

> **Tunnel server 会以\_做分隔符，提取出appName，方便按应用进行管理**。

###### 配置参数 ######

解压的 arthas 目录下的 arthas.properties，或者在 spring boot 应用的application.properties里配置appName。

##### Arthas Spring Boot Starter的agent服务连接Jar #####

> **只支持 springboot2**

*  maven的仓库地址：[search.maven.org/search?q=a:…][search.maven.org_search_q_a]

![format_png 6][]

*  配置 maven 依赖：

arthas.version:3.6.7

<dependency><groupId>com.taobao.arthas</groupId><artifactId>arthas-spring-boot-starter</artifactId><version>${arthas.version}</version></dependency>复制代码

应用启动后，spring 会启动 arthas，并且 attach 自身进程。如果你不知道如何创建或者引入哪些依赖，可以采用一键创建包含 Arthas Spring Boot Starter 的工程：[点击跳转到云原生脚手架][Link 1]

![format_png 7][]

可以看到最下面已经自动勾选了arthas的监控机制体系。

![format_png 8][]

###### application.yml配置 ######

arthas:agent-name:nihaotestagent-id:URJZ5L48RPBR2ALI5K4V#需手工指定agent-idtunnel-server:ws://127.0.0.1:7777/ws复制代码

##### 查看 Endpoint 信息 #####

需要配置 spring boot 暴露 endpoint：假定endpoint 端口是 8080，则通过下面 url 可以查看：

> [http://localhost:8080/actuator/arthas][http_localhost_8080_actuator_arthas]

{"arthasConfigMap":{"agent-id":"hsehdfsfghhwertyfad","tunnel-server":"ws://47.75.156.201:7777/ws",}}复制代码

> **最后，启动SpringBoot服务即可**。

##### 非 spring boot 应用使用方式 #####

非 Spring Boot 应用，可以通过下面的方式来使用：

<dependency><groupId>com.taobao.arthas</groupId><artifactId>arthas-agent-attach</artifactId><version>${arthas.version}</version></dependency><dependency><groupId>com.taobao.arthas</groupId><artifactId>arthas-packaging</artifactId><version>${arthas.version}</version></dependency>复制代码

###### attach本身的服务进行探针探测。 ######

import com.taobao.arthas.agent.attach.ArthasAgent;
    publicclassArthasAttachExample {
    	publicstaticvoidmain(String[] args) {
    		ArthasAgent.attach();
    	}
    }
    复制代码

也可以配置属性：

HashMap<String, String> configMap = newHashMap<String, String>();
    configMap.put("arthas.appName", "demo");
    configMap.put("arthas.tunnelServer", "ws://127.0.0.1:7777/ws");
    ArthasAgent.attach(configMap);
    复制代码

#### Tunnel Server 的管理页面 ####

需要在 spring boot 的application.properties里配置 arthas.enable-detail-pages=true

> 注意，开放管理页面有风险！管理页面没有安全拦截功能，务必自行增加安全措施。

在本地启动 tunnel-server，然后使用as.sh attach，并且指定应用名--app-name test：

$ as.sh --tunnel-server 'ws://127.0.0.1:7777/ws' --app-name test
    telnet connecting to arthas server... current timestamp is1627539688
    Trying 127.0.0.1...
    Connected to 127.0.0.1.
    Escape character is'^]'.
      ,---.  ,------. ,--------.,--.  ,--.  ,---.   ,---.
     /  O  \ |  .--. ''--.  .--'|  '--'  | /  O  \ '   .-'
    |  .-.  ||  '--'.'   |  |   |  .--.  ||  .-.  |`.  `-.
    |  | |  ||  |\  \    |  |   |  |  |  ||  | |  |.-'    |
    `--' `--'`--''--'   `--'   `--'  `--'`--' `--'`-----'
    
    wiki       https://arthas.aliyun.com/doc
    tutorials  https://arthas.aliyun.com/doc/arthas-tutorials.html
    version    3.5.3
    main_classdemo.MathGame
    pid        65825
    time       2022-07-2914:21:29
    id         test_PE3LZO9NA9ENJYTPGL9L
    
    复制代码

然后访问 tunnel-server，可以看到所有连接的应用列表：

http://localhost:8080/apps.html
    复制代码

![format_png 9][]

再打开详情，则可以看到连接的所有 agent 列表：

http://localhost:8080/agents.html?app=test复制代码

![format_png 10][]

作者：洛神灬殇

链接：[https://juejin.cn/post/7213744681393176633][https_juejin.cn_post_7213744681393176633]

[Arthas tunnel server]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Farthas%2Freleases
[format_png]: https://img-blog.csdnimg.cn/img_convert/808bd34887247158f03c0091e12d566f.webp?x-oss-process=image/format,png
[arthas.aliyun.com_download_ar]: https://link.juejin.cn?target=https%3A%2F%2Farthas.aliyun.com%2Fdownload%2Farthas-tunnel-server%2Flatest_version%3Fmirror%3Daliyun
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/efbd6e4da4f14e2bd73d37d1feb4da14.webp?x-oss-process=image/format,png
[http_127.0.0.1_8563]: https://link.juejin.cn?target=http%3A%2F%2F127.0.0.1%3A8563%2F%25E3%2580%2582
[http_127.0.0.1_8080]: https://link.juejin.cn?target=http%3A%2F%2F127.0.0.1%3A8080%2F
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/e4e18b90887aba9d6668bf171f81e42d.webp?x-oss-process=image/format,png
[http_127.0.0.1_8080_actuator_arthas]: https://link.juejin.cn?target=http%3A%2F%2F127.0.0.1%3A8080%2Factuator%2Farthas
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/6c2b89dff04e779e1158bdab9e4d5130.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/f1e3d8e6c3f431a96f6fab59422b766a.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/53c45da6485b98e6ba6e47f6128c7807.webp?x-oss-process=image/format,png
[http_localhost_8080_arthas_agentId]: https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8080%2Farthas%25EF%25BC%258C%25E8%25BE%2593%25E5%2585%25A5agentId%25EF%25BC%258C%25E5%25B0%25B1%25E5%258F%25AF%25E4%25BB%25A5%25E8%25BF%259E%25E6%258E%25A5%25E5%2588%25B0%25E6%259C%25AC%25E6%259C%25BA%2F%25E5%2585%25B6%25E4%25BB%2596%25E6%259C%25BA%25E5%2599%25A8%25E4%25B8%258A%25E4%25B8%258A%25E7%259A%2584
[search.maven.org_search_q_a]: https://link.juejin.cn?target=https%3A%2F%2Fsearch.maven.org%2Fsearch%3Fq%3Da%3Aarthas-spring-boot-starter
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/79a1ace86665c02f686e7977869b38fd.webp?x-oss-process=image/format,png
[Link 1]: https://link.juejin.cn?target=https%3A%2F%2Fstart.aliyun.com%2Fbootstrap.html%2F%23!dependencies%3Darthas
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/8b147e6c1605002adf17e973c5d40b45.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/e4d4cb34a684977b5ed65317ad8279d2.webp?x-oss-process=image/format,png
[http_localhost_8080_actuator_arthas]: https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8080%2Factuator%2Farthas
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/93c01bcca87bb3b6b007f9f410051ce2.webp?x-oss-process=image/format,png
[format_png 10]: https://img-blog.csdnimg.cn/img_convert/bf945b031ad4d4ba0a316dce61b7bb0a.webp?x-oss-process=image/format,png
[https_juejin.cn_post_7213744681393176633]: https://juejin.cn/post/7213744681393176633