Name	Name	Last commit message	Last commit date
parent directory ..
src	src
README.md	README.md
pom.xml	pom.xml

study-arthas

原理分析

Idea 插件使用

https://plugins.jetbrains.com/plugin/13581-arthas-idea

https://www.yuque.com/arthas-idea-plugin/help/pe6i45

在线文档

https://www.yuque.com/arthas-idea-plugin/help/pe6i45

https://www.yuque.com/arthas-idea-plugin

例如

cd /Users/abcd/abcd/software/arthas

java -jar arthas-boot.jar

watch com.bage.study.best.practice.controller.UserController insert '{params,returnObj,throwExp}'  -n 5  -x 3 

http://localhost:8000/user/insert

参考链接

github https://github.com/alibaba/arthas
Arthas https://alibaba.github.io/arthas/
doc https://arthas.aliyun.com/doc/
在线操作验证 https://alibaba.github.io/arthas/arthas-tutorials?language=cn

基本功能

这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
是否有一个全局视角来查看系统的运行状况？
有什么办法可以监控到 JVM 的实时运行状态？
怎么快速定位应用的热点，生成火焰图？
怎样直接从 JVM 内查找某个类的实例？

使用

下载

官网下载

curl -O https://alibaba.github.io/arthas/arthas-demo.jar

启动、Attach

cd /Users/abcd/abcd/software/arthas

java -jar arthas-boot.jar

选择attach的Java进程，输入对应的序号

$ java -jar arthas-boot.jar
* [1]: 35542
  [2]: 71560 arthas-demo.jar

dashboard

查看概况，jvm内存使用情况等

dashboard

thread

查看线程信息，查看线程的堆栈

查看所有线程

thread

查看id=12345线程的情况

thread 12345

查看繁忙前5 线程

thread -n 5

查看所有的阻塞线程

thread -b

每1秒查看

thread -i 1000

jvm

查看当前JVM信息

基本使用

jvm

sysprop

查看当前JVM的系统属性

基本使用

sysprop

sysenv

查看当前JVM的环境

基本使用

sysenv

ognl

执行ognl表达式

函数使用

ognl '@java.lang.System@out.println("hello")'

属性查看

ognl '@demo.MathGame@random'

阿里巴巴 Arthas 使用

当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：

这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
是否有一个全局视角来查看系统的运行状况？
有什么办法可以监控到JVM的实时运行状态？
怎么快速定位应用的热点，生成火焰图？

快速安装

curl -O https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar

启动Demo

curl -O https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar

Attach

在命令行下面执行（使用和目标进程一致的用户启动，否则可能attach失败）：

curl -O https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar

dashboard

输入dashboard，按回车/enter，会展示当前进程的信息，按ctrl+c可以中断执行。

      $ dashboard
      ID     NAME                   GROUP          PRIORI STATE  %CPU    TIME   INTERRU DAEMON
      17     pool-2-thread-1        system         5      WAITIN 67      0:0    false   false
      27     Timer-for-arthas-dashb system         10     RUNNAB 32      0:0    false   true
      11     AsyncAppender-Worker-a system         9      WAITIN 0       0:0    false   true
      9      Attach Listener        system         9      RUNNAB 0       0:0    false   true
      3      Finalizer              system         8      WAITIN 0       0:0    false   true
      2      Reference Handler      system         10     WAITIN 0       0:0    false   true
      4      Signal Dispatcher      system         9      RUNNAB 0       0:0    false   true
      26     as-command-execute-dae system         10     TIMED_ 0       0:0    false   true
      13     job-timeout            system         9      TIMED_ 0       0:0    false   true
      1      main                   main           5      TIMED_ 0       0:0    false   false
      14     nioEventLoopGroup-2-1  system         10     RUNNAB 0       0:0    false   false
      18     nioEventLoopGroup-2-2  system         10     RUNNAB 0       0:0    false   false
      23     nioEventLoopGroup-2-3  system         10     RUNNAB 0       0:0    false   false
      15     nioEventLoopGroup-3-1  system         10     RUNNAB 0       0:0    false   false
      Memory             used   total max    usage GC
      heap               32M    155M  1820M  1.77% gc.ps_scavenge.count  4
      ps_eden_space      14M    65M   672M   2.21% gc.ps_scavenge.time(m 166
      ps_survivor_space  4M     5M    5M           s)
      ps_old_gen         12M    85M   1365M  0.91% gc.ps_marksweep.count 0
      nonheap            20M    23M   -1           gc.ps_marksweep.time( 0
      code_cache         3M     5M    240M   1.32% ms)
      Runtime
      os.name                Mac OS X
      os.version             10.13.4
      java.version           1.8.0_162
      java.home              /Library/Java/JavaVir
                             tualMachines/jdk1.8.0
                             _162.jdk/Contents/Hom
                             e/jre

thread

thread {threadId} 会打印线程的栈

     $ thread 10086 | grep 'main('
         at demo.MathGame.main(MathGame.java:17)

watch

通过watch命令来查看demo.MathGame#primeFactors函数的返回值：

$ watch demo.MathGame primeFactors returnObj
Press Ctrl+C to abort.
Affect(class-cnt:1 , method-cnt:1) cost in 107 ms.
ts=2018-11-28 19:22:30; [cost=1.715367ms] result=null
ts=2018-11-28 19:22:31; [cost=0.185203ms] result=null
ts=2018-11-28 19:22:32; [cost=19.012416ms] result=@ArrayList[
    @Integer[5],
    @Integer[47],
    @Integer[2675531],
]

查看入参响应

$ watch com.bage.study.best.practice.service.UserServiceImpl query "{params,returnObj}"
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 94 ms, listenerId: 2
method=com.bage.study.best.practice.service.UserServiceImpl.query location=AtExit
ts=2023-11-06 12:35:41; [cost=266.713ms] result=@ArrayList[
    @Object[][isEmpty=false;size=1],
    @ArrayList[isEmpty=false;size=1],

条件过滤

$ watch com.bage.study.best.practice.service.UserServiceImpl query "{params[0],target,returnObj}" "'15215007541'.equals(params[0])"

退出

如果只是退出当前的连接，可以用quit或者exit命令。Attach到目标进程上的arthas还会继续运行，端口会保持开放，下次连接时可以直接连接上。如果想完全退出arthas，可以执行stop命令。

进阶使用

基础命令

help——查看命令帮助信息
cat——打印文件内容，和linux里的cat命令类似
echo–打印参数，和linux里的echo命令类似
grep——匹配查找，和linux里的grep命令类似
tee——复制标准输入到标准输出和指定的文件，和linux里的tee命令类似
pwd——返回当前的工作目录，和linux命令类似
cls——清空当前屏幕区域
session——查看当前会话的信息
reset——重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类
version——输出当前目标 Java 进程所加载的 Arthas 版本号
history——打印命令历史
quit——退出当前 Arthas 客户端，其他 Arthas 客户端不受影响
stop——关闭 Arthas 服务端，所有 Arthas 客户端全部退出
keymap——Arthas快捷键列表及自定义快捷键

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功能

class/classloader相关

sc——查看JVM已加载的类信息
sm——查看已加载类的方法信息
jad——反编译指定已加载类的源码
mc——内存编译器，内存编译.java文件为.class文件
redefine——加载外部的.class文件，redefine到JVM里
dump——dump 已加载类的 byte code 到特定目录
classloader——查看classloader的继承树，urls，类加载信息，使用classloader去getResource

monitor/watch/trace相关

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

monitor——方法执行监控
watch——方法执行数据观测
trace——方法内部调用路径，并输出方法路径上的每个节点上耗时
stack——输出当前方法被调用的调用路径
tt——方法执行数据的时空隧道，记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下调用进行观测

profiler/火焰图

https://github.com/brendangregg/FlameGraph

profiler–使用async-profiler对应用采样，生成火焰图

生成火焰图

[arthas@21777]$ profiler start
Profiling started

停止

[arthas@21777]$ profiler stop --format html
OK
profiler output file: /Users/bage/bage/github/study/arthas-output/20230912-190608.html


[arthas@21777]$ profiler stop
OK
profiler output file: /Users/bage/bage/github/study/arthas-output/20230912-190615.html

访问

http://localhost:3658/arthas-output/

options

options——查看或设置Arthas全局开关

管道

Arthas支持使用管道对上述命令的结果进行进一步的处理，如sm java.lang.String * | grep 'index'

grep——搜索满足条件的�结果
plaintext——将�命令的结果去除ANSI颜色
wc——按行统计输出结果

后台异步任务

当线上出现偶发的问题，比如需要watch某个条件，而这个条件一天可能才会出现一次时，异步后台任务就派上用场了，详情请参考这里

使用 > 将结果重写向到日志文件，使用 & 指定命令是后台运行，session断开不影响任务执行（生命周期默认为1天）
jobs——列出所有job
kill——强制终止任务
fg——将暂停的任务拉到前台执行
bg——将暂停的任务放到后台执行

Web Console

通过websocket连接Arthas。

Web Console

以java agent方式启动

以java agent方式启动

用户数据回报

在3.1.4版本后，增加了用户数据回报功能，方便统一做安全或者历史数据统计。

在启动时，指定stat-url，就会回报执行的每一行命令，比如： ./as.sh --stat-url 'http://192.168.10.11:8080/api/stat'

在tunnel server里有一个示例的回报代码，用户可以自己在服务器上实现。

StatController.java

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Files

study-arthas

study-arthas

README.md

study-arthas

Idea 插件使用

参考链接

基本功能

使用

下载

启动、Attach

dashboard

thread

jvm

sysprop

sysenv

ognl

快速安装

启动Demo

Attach

dashboard

thread

watch

退出

进阶使用

基础命令

jvm相关

class/classloader相关

monitor/watch/trace相关

profiler/火焰图

options

管道

后台异步任务

Web Console

以java agent方式启动

用户数据回报

其他特性

Files

study-arthas

Directory actions

More options

Directory actions

More options

Latest commit

History

study-arthas

Folders and files

parent directory

README.md

study-arthas

Idea 插件使用

参考链接

基本功能

使用

下载

启动、Attach

dashboard

thread

jvm

sysprop

sysenv

ognl

快速安装

启动Demo

Attach

dashboard

thread

watch

退出

进阶使用

基础命令

jvm相关

class/classloader相关

monitor/watch/trace相关

profiler/火焰图

options

管道

后台异步任务

Web Console

以java agent方式启动

用户数据回报

其他特性