在 docker 容器中使用 Java 诊断工具 —— Arthas

一、概述

使用 docker 容器部署项目已经成为开发者必须掌握的技能，当使用 docker 容器部署项目后，如何在容器中对 Java 应用进行实时诊断，这篇文章主要介绍在 docker 容器中如何使用 Java 诊断工具 —— Arthas 。在容器中使用 Arthas 和在服务器上面使用是没有太大区别的，通常情况下一个容器中只会运行我们的应用服务这一个 Java 进程，所以在容器中使用 Arthas 只会看到一个 Java 进程。关于 Arthas 的详细说明可以查看下面的官方文档，这里只会对自己在 docker 容器中使用过的 Arthas 命令通过案例进行介绍。

这篇文章涉及的内容如下：

• 实时修改日志级别
• 实时查看方法调用输入输出参数
• 实时在线热更新代码

Arthas 中文文档：http://arthas.gitee.io/

二、在 docker 容器中安装 Arthas

1、构建 docker 容器

这里使用一个 spring boot 的 demo 进行实践，其中只包括一个 controller, 内容如下：

@Slf4j
@RestController
public class TestController {

    @GetMapping("hello/{content}")
    public String hello(@PathVariable(value = "content") String content) {
        log.debug("----------log debug----------");
        log.info("----------log info----------");
        log.warn("----------log warn----------");
        log.error("----------log error----------");
        return "返回结果：" + content;
    }
}

构建镜像的 Dockerfile 内容如下：

FROM openjdk:8u232-jdk
WORKDIR /app
LABEL maintainer="peterwd" app="devops-demo"
COPY target/devops-demo.jar devops-demo.jar
EXPOSE 8080
CMD java -jar devops-demo.jar

使用如下命令构建镜像：

docker build -t devops-demo .

使用下面的命令启动容器：

docker run --name devop-demo -d -p 8080:8080 devops-demo

构建好镜像之后使用如下命令进入 docker 容器：

docker exec -it devops-demo bash

2、安装 Arthas

进入 docker 容器之后，使用如下命令安装 Arthas：

wget https://arthas.aliyun.com/arthas-boot.jar

使用如下命令启动 Arthas：

java -jar arthas-boot.jar

启动 Arthas 的过程中会选择对应的 Java 进程，在 docker 容器中通常只有一个 Java 进程，所以直接 1 即可，如果有多个 Java 进程输入前面的编号。
如下图所示：

三、Arthas 命令介绍

请注意，这些命令，都通过字节码增强技术来实现的，会在指定类的方法中插入一些切面来实现数据统计和观测，因此在线上、预发使用时，请尽量明确需要观测的类、方法以及条件，诊断结束要执行 stop 或将增强过的类执行 reset 命令。

1、基础命令

help——查看命令帮助信息

cat——打印文件内容，和linux里的cat命令类似

echo–打印参数，和linux里的echo命令类似

grep——匹配查找，和linux里的grep命令类似

base64——base64编码转换，和linux里的base64命令类似

tee——复制标准输入到标准输出和指定的文件，和linux里的tee命令类似

pwd——返回当前的工作目录，和linux命令类似

cls——清空当前屏幕区域

session——查看当前会话的信息

reset——重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类

version——输出当前目标 Java 进程所加载的 Arthas 版本号

history——打印命令历史

quit——退出当前 Arthas 客户端，其他 Arthas 客户端不受影响

stop——关闭 Arthas 服务端，所有 Arthas 客户端全部退出

keymap——Arthas快捷键列表及自定义快捷键

2、jvm 相关命令

dashboard——当前系统的实时数据面板

thread——查看当前 JVM 的线程堆栈信息

jvm——查看当前 JVM 的信息

sysprop——查看和修改JVM的系统属性

sysenv——查看JVM的环境变量

vmoption——查看和修改JVM里诊断相关的option

perfcounter——查看当前 JVM 的Perf Counter信息

logger——查看和修改logger

getstatic——查看类的静态属性

ognl——执行ognl表达式

mbean——查看 Mbean 的信息

heapdump——dump java heap, 类似jmap命令的heap dump功能

vmtool——从jvm里查询对象，执行forceGc

3、class/classloader相关命令

sc——查看JVM已加载的类信息

sm——查看已加载类的方法信息

jad——反编译指定已加载类的源码

mc——内存编译器，内存编译.java文件为.class文件

retransform——加载外部的.class文件，retransform到JVM里

redefine——加载外部的.class文件，redefine到JVM里

dump——dump 已加载类的 byte code 到特定目录

classloader——查看classloader的继承树，urls，类加载信息，使用classloader去getResource

4、monitor/watch/trace相关命令

monitor——方法执行监控

watch——方法执行数据观测

trace——方法内部调用路径，并输出方法路径上的每个节点上耗时

stack——输出当前方法被调用的调用路径

tt——方法执行数据的时空隧道，记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下调用进行观测

三、使用 Arthas 的 logger 实时修改类的日志级别

前面简单介绍了 Arthas 的命令，这里主要介绍使用 Arthas 的 logger 实时修改类的日志级别，这里的使用的 demo 中定义了四种日志级别，分别是 debug、info、warn、error，通过动态修改不同日志级别来控制日志的显示。

log4j 定义了8个级别的log（除去 OF F和 ALL，可以说分为6个级别），优先级从高到低依次为：
OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。

如果将log level设置在某一个级别上，那么比此级别优先级高的log都能打印出来。例如，如果设置优先级为WARN，那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出，而INFO、DEBUG、TRACE、 ALL级别的log则会被忽略。Log4j建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。

1、使用 sc 命令查看 JVM 加载的类信息

命令：sc -d [查找类的全路径 或者 *类名]

sc 命令支持通过类名模糊查找类信息，-d 显示详细信息，获取到类的全路径名和 classLoaderHash 如下所示：

[arthas@7]$ sc -d *TestController 
 class-info        devops.demo.controller.TestController
 code-source       file:/app/devops-demo.jar!/BOOT-INF/classes!/
 name              devops.demo.controller.TestController
 isInterface       false
 isAnnotation      false
 isEnum            false
 isAnonymousClass  false
 isArray           false
 isLocalClass      false
 isMemberClass     false
 isPrimitive       false
 isSynthetic       false
 simple-name       TestController
 modifier          public
 annotation        org.springframework.web.bind.annotation.RestController
 interfaces
 super-class       +-java.lang.Object
 class-loader      +-org.springframework.boot.loader.LaunchedURLClassLoader@7daf6ecc
                     +-sun.misc.Launcher$AppClassLoader@70dea4e
                       +-sun.misc.Launcher$ExtClassLoader@1a04f701
 classLoaderHash   7daf6ecc    

2、使用 logger 命令查看指定类的日志级别

命令：logger --name [查找类的全路径]

logger 用来查看和修改logger信息，--name 指定全路径类名，如下所示：

[arthas@7]$ logger --name devops.demo.controller.TestController 
 name                               devops.demo.controller.TestController                                                                                                                                        
 class                              ch.qos.logback.classic.Logger                                                                                                                                                
 classLoader                        org.springframework.boot.loader.LaunchedURLClassLoader@7daf6ecc                                                                                                              
 classLoaderHash                    7daf6ecc                                                                                                                                                                     
 level                              null                                                                                                                                                                         
 effectiveLevel                     INFO                                                                                                                                                                         
 additivity                         true                                                                                                                                                                         
 codeSource                         jar:file:/app/devops-demo.jar!/BOOT-INF/lib/logback-classic-1.2.3.jar!/    

3、使用 logger 命令修改指定类的日志级别

命令：logger -c [classLoaderHash的值] --name [查找类的全路径] --level [待更新的日志level]

-c 指定 classLoaderHash 的值 --level 指定要更新的日志级别，如下所示：

[arthas@7]$ logger -c 7daf6ecc --name devops.demo.controller.TestController --level debug
Update logger level success.

4、验证修改日志级别的结果

默认情况下类的日志级别是 info，这里访问 demo 输出日志没有 debug 的信息，如下图所示：

使用如下命令修改 logger 的日志级别为 debug：

[arthas@7]$ logger -c 7daf6ecc --name devops.demo.controller.TestController --level debug
Update logger level success.

再次访问，输出日志有 debug 信息，如下图所示：

使用如下命令修改 logger 的日志级别为 error：

[arthas@7]$ logger -c 7daf6ecc --name devops.demo.controller.TestController --level error
Update logger level success.

再次访问，输出日志只有 error 信息，如下图所示：

四、使用 Arthas 的 watch 查看方法输入输出参数

命令： watch 全路径类名 方法名 [表达式]

watch 命令的使用说明如下：
watch 用来查看指定方法调用的输入输出参数，返回值以及抛出的异常信息，watch 可以使用的表达式如下：

target : the object
clazz : the object's class
method : the constructor or method
params : the parameters array of method
params[0..n] : the element of parameters array
returnObj : the returned object of method
throwExp : the throw exception of method
isReturn : the method ended by return
isThrow : the method ended by throwing exception
#cost : the execution time in ms of method invocation

关于 watch 命令的详细说明可以使用 watch --help 查看，这里只介绍示例方法的使用。

使用如下命令查看方法的调用参数:

[arthas@7]$ watch devops.demo.controller.TestController hello params
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 26 ms, listenerId: 3
method=devops.demo.controller.TestController.hello location=AtExit
ts=2021-05-26 11:36:58; [cost=0.627099ms] result=@Object[][
    @String[测试方法调用参数],
]

使用如下命令查看方法的返回参数：

[arthas@7]$ watch devops.demo.controller.TestController hello returnObj 
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 24 ms, listenerId: 4
method=devops.demo.controller.TestController.hello location=AtExit
ts=2021-05-26 11:39:18; [cost=0.525488ms] result=@String[返回结果：测试方法返回参数]

五、使用 Arthas 实现在线代码热更新

使用 Arthas 提供的 sc jad mc redefine 这四个命令就可以实现在线代码热更新，这个功能非常强大，但是也非常危险，在容器中使用要控制进入容器的权限，在服务器使用也要控制服务器的使用权限，下面以提供的 demo 为例详细说明如何使用这几个命令实现代码热更新。

1、使用 sc 命令查找 JVM 加载的类信息

命令：sc -d [查找类的全路径 或者 *类名]

sc 命令支持通过类名模糊查找类信息，-d 显示详细信息，获取到类的全路径名和 classLoaderHash 如下所示：

[arthas@7]$ sc -d *TestController 
 class-info        devops.demo.controller.TestController
 code-source       file:/app/devops-demo.jar!/BOOT-INF/classes!/
 name              devops.demo.controller.TestController
 isInterface       false
 isAnnotation      false
 isEnum            false
 isAnonymousClass  false
 isArray           false
 isLocalClass      false
 isMemberClass     false
 isPrimitive       false
 isSynthetic       false
 simple-name       TestController
 modifier          public
 annotation        org.springframework.web.bind.annotation.RestController
 interfaces
 super-class       +-java.lang.Object
 class-loader      +-org.springframework.boot.loader.LaunchedURLClassLoader@7daf6ecc
                     +-sun.misc.Launcher$AppClassLoader@70dea4e
                       +-sun.misc.Launcher$ExtClassLoader@1a04f701
 classLoaderHash   7daf6ecc    

2、使用 jad 命令反编译已加载类的源码

命令：jad --source-only 类的全路径 > 类名.java

jad 命令反编译已加载类的源码, --source-only 指定只输出源码，> 类名.java 将输出结果保存到当前目录的 类名.java 文件

jad --source-only devops.demo.controller.TestController > TestController.java

查看反编译的内容如下：

[arthas@7]$ cat TestController.java 
       /*
        * Decompiled with CFR.
        * 
        * Could not load the following classes:
        *  org.slf4j.Logger
        *  org.slf4j.LoggerFactory
        *  org.springframework.web.bind.annotation.GetMapping
        *  org.springframework.web.bind.annotation.PathVariable
        *  org.springframework.web.bind.annotation.RestController
        */
       package devops.demo.controller;
       
       import org.slf4j.Logger;
       import org.slf4j.LoggerFactory;
       import org.springframework.web.bind.annotation.GetMapping;
       import org.springframework.web.bind.annotation.PathVariable;
       import org.springframework.web.bind.annotation.RestController;
       
       @RestController
       public class TestController {
           private static final Logger log = LoggerFactory.getLogger(TestController.class);
       
           @GetMapping(value={"hello/{content}"})
           public String hello(@PathVariable(value="content") String content) {
/*14*/         log.debug("----------log debug----------");
/*15*/         log.info("----------log info----------");
/*16*/         log.warn("----------log warn----------");
/*17*/         log.error("----------log error----------");
               return "返回结果：" + content;
           }
       }

在容器中没有 vim 编辑器，不方便修改，可以将反编译出来的源码复制出来，修改完成之后，通过 docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH 命令将修改后的内容复制到容器中。

docker cp TestController.java devop-demo:/app

修改上面反编译出来的源代码，修改如下：

[arthas@7]$ cat TestController.java 
       /*
        * Decompiled with CFR.
        * 
        * Could not load the following classes:
        *  org.slf4j.Logger
        *  org.slf4j.LoggerFactory
        *  org.springframework.web.bind.annotation.GetMapping
        *  org.springframework.web.bind.annotation.PathVariable
        *  org.springframework.web.bind.annotation.RestController
        */
       package devops.demo.controller;
       
       import org.slf4j.Logger;
       import org.slf4j.LoggerFactory;
       import org.springframework.web.bind.annotation.GetMapping;
       import org.springframework.web.bind.annotation.PathVariable;
       import org.springframework.web.bind.annotation.RestController;
       
       @RestController
       public class TestController {
           private static final Logger log = LoggerFactory.getLogger(TestController.class);
       
           @GetMapping(value={"hello/{content}"})
           public String hello(@PathVariable(value="content") String content) {
/*14*/         log.debug("----------log debug----------");
/*15*/         log.info("----------log info----------");
/*16*/         log.warn("----------log warn----------");
/*17*/         log.error("----------log error----------");
               return "返回结果：测试热更新代码 " + content;
           }
       }

3、使用 mc 内存编译.java文件为.class文件

命令 mc -c 类加载器hash java源码路径 -d /tmp

mc 内存编译.java文件为.class文件，-c 类加载器hash 指定前面通过 sc -d 命令查找到的 classLoaderHash ， -d /tmp 指定编译输出的 class 文件的目录为 /tmp, 不指定则输出到当前目录。

[arthas@7]$ mc -c 7daf6ecc TestController.java  -d /tmp
Memory compiler output:
/tmp/devops/demo/controller/TestController.class
Affect(row-cnt:1) cost in 993 ms.

4、使用 redefine 加载外部的.class文件

命令：redefine class文件路径

这里的 class 文件路径填写上面反编译输出的路径，如下所示：

[arthas@7]$ redefine /tmp/devops/demo/controller/TestController.class
redefine success, size: 1, classes:
devops.demo.controller.TestController

5、验证热更新结果

root@devops-demo-7bdf65859c-mtjqm:/app# curl localhost:8080/hello/test
返回结果：测试热更新代码 test

六、总结

这篇文章简单介绍了 Arthas 在 docker 容器的使用，主要介绍了 logger 和 watch 命令以及如何实现在线代码热更新，后续有使用到其他命令再来补充，详细信息可以查阅官方文档。