乐趣区

关于java:在-docker-容器中使用-Java-诊断工具-Arthas

jiezi

一、概述

应用 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 命令以及如何实现在线代码热更新，后续有应用到其余命令再来补充，详细信息能够查阅官网文档。

退出移动版