test/arthas

Fork 0

mirror of https://gitee.com/arthas/arthas.git synced 2024-12-02 04:08:34 +08:00

CrazyCoder 59b87ca10c

profiler command support --wall option(#2905 )

2024-10-04 20:51:54 +08:00

14 KiB

Raw Blame History

profiler

profiler在线教程

::: tip 使用async-profiler生成火焰图 :::

profiler 命令支持生成应用热点的火焰图。本质上是通过不断的采样，然后把收集到的采样结果生成火焰图。

profiler 命令基本运行结构是 profiler action [actionArg]

profiler 命令的格式基本与上游项目 async-profiler 保持一致，详细的使用方式可参考上游项目的 README、Github Disscussions 以及其他文档资料。

参数说明

参数名称	参数说明
action	要执行的操作
actionArg	属性名模式
[i:]	采样间隔（单位：ns）（默认值：10'000'000，即 10 ms）
[f:]	将输出转储到指定路径
[d:]	运行评测指定秒
[e:]	要跟踪哪个事件（cpu, alloc, lock, cache-misses 等），默认是 cpu

启动 profiler

$ profiler start
Started [cpu] profiling

::: tip 默认情况下，生成的是 cpu 的火焰图，即 event 为cpu。可以用--event参数指定其他性能分析模式，见下文。 :::

获取已采集的 sample 的数量

$ profiler getSamples
23

查看 profiling 状态

$ profiler status
[cpu] profiling is running for 4 seconds

可以查看当前 profiler 在采样哪种event和采样时间。

查看 profiler 自身的内存占用

$ profiler meminfo
Call trace storage:   10244 KB
      Dictionaries:      72 KB
        Code cache:   12890 KB
------------------------------
             Total:   23206 KB

停止 profiler

生成火焰图格式结果

默认情况下，结果是 Flame Graph 格式的 html 文件，也可以用 -o 或 --format 参数指定其他内容格式，包括 flat、traces、collapsed、flamegraph、tree、jfr。

$ profiler stop --format flamegraph
profiler output file: /tmp/test/arthas-output/20211207-111550.html
OK

在--file参数指定的文件名后缀为 html 或 jfr 时，文件格式可以被推断出来。比如--file /tmp/result.html 将自动生成火焰图。

通过浏览器查看 arthas-output 下面的 profiler 结果

默认情况下，arthas 使用 3658 端口，则可以打开： http://localhost:3658/arthas-output/ 查看到arthas-output目录下面的 profiler 结果：

点击可以查看具体的结果：

::: tip 如果是 chrome 浏览器，可能需要多次刷新。 :::

profiler 支持的 events

在不同的平台，不同的 OS 下面，支持的 events 各有不同。比如在 macos 下面：

$ profiler list
Basic events:
  cpu
  alloc
  lock
  wall
  itimer

在 linux 下面

$ profiler list
Basic events:
  cpu
  alloc
  lock
  wall
  itimer
Java method calls:
  ClassName.methodName
Perf events:
  page-faults
  context-switches
  cycles
  instructions
  cache-references
  cache-misses
  branch-instructions
  branch-misses
  bus-cycles
  L1-dcache-load-misses
  LLC-load-misses
  dTLB-load-misses
  rNNN
  pmu/event-descriptor/
  mem:breakpoint
  trace:tracepoint
  kprobe:func
  uprobe:path

如果遇到 OS 本身的权限/配置问题，然后缺少部分 event，可以参考 async-profiler 的文档。

可以使用 check action 测试某个 event 是否可用，此 action 的参数格式与 start 一致。

可以用--event参数指定要采样的事件，比如 alloc 表示分析内存分配情况：

$ profiler start --event alloc

恢复采样

$ profiler resume
Started [cpu] profiling

start和resume的区别是：start会清除已有的分析结果重新开始，resume则会保留已有的结果，将新的分析结果附加到已有结果中。

通过执行profiler getSamples可以查看 samples 的数量来验证。

Dump 分析结果

$ profiler dump
OK

dump action 将性能分析的结果保存到默认文件或指定的文件中，但 profiling 过程不会停止。例如，如果使用 start action 启动 profiling，5 秒后执行 dump action，2 秒后再次执行 dump action，将会得到 2 个结果文件，第一个文件包括 0~5 秒的分析结果，第二个文件包括 0~7 秒的分析结果。

使用`execute`来执行复杂的命令

比如开始采样：

profiler execute 'start,framebuf=5000000'

停止采样，并保存到指定文件里：

profiler execute 'stop,file=/tmp/result.html'

具体的格式参考： arguments.cpp

查看所有支持的 action

$ profiler actions
Supported Actions: [resume, dumpCollapsed, getSamples, start, list, version, execute, meminfo, stop, load, dumpFlat, dump, actions, dumpTraces, status, check]

查看版本

$ profiler version
Async-profiler 2.9 built on May  8 2023
Copyright 2016-2021 Andrei Pangin

配置 Java 栈深度

可以使用 -j 或 --jstackdepth 选项指定最大 Java 栈深度。如果指定值大于默认值 2048，该选项会被忽略。当你不希望看到特别深的栈轨迹的时候，这个选项会很有用，以下是一个使用样例：

profiler start -j 256

各线程分别进行 profiling

可以使用 -t 或 --threads 标志选项令 profiling 对各线程分别进行，每个栈轨迹都会以指示单个线程的帧结束。

profiler start -t

配置 include/exclude 来过滤数据

如果应用比较复杂，生成的内容很多，想只关注部分 stack traces，可以通过 --include/--exclude 过滤 stack traces，--include 表示定义的匹配表达式必须出现在 stack traces，相反 --exclude 表示定义的匹配表达式一定不会出现在 stack traces。匹配表达式可以以*开始或者结束,* 表示任何（可能为空）字符序列。比如

profiler stop --include 'java/*' --include 'com/demo/*' --exclude '*Unsafe.park*'

--include/--exclude 都支持多次设置，但是需要配置在命令行的最后。也可使用短参数格式 -I/-X。注意--include/--exclude只支持在stopaction或者带有-d/--duration参数的startaction中指定，否则不生效。

指定执行时间

比如，希望 profiler 执行 300 秒自动结束，可以用 -d/--duration 参数为 collect action 指定时间：

profiler collect --duration 300

生成 jfr 格式结果

注意，jfr 只支持在 start时配置。如果是在stop时指定，则不会生效。

profiler start --file /tmp/test.jfr
profiler start -o jfr

file参数支持一些变量：

时间戳： --file /tmp/test-%t.jfr
进程 ID： --file /tmp/test-%p.jfr

生成的结果可以用支持 jfr 格式的工具来查看。比如：

JDK Mission Control ： https://github.com/openjdk/jmc
JProfiler ： https://github.com/alibaba/arthas/issues/1416

控制分析结果的格式

使用 -s 选项将结果中的 Fully qualified name 替换为简单名称，如 demo.MathGame.main 替换为 MathGame.main。使用 -g 选项指定输出方法签名，如 demo.MathGame.main 替换为 demo.MathGame.main([Ljava/lang/String;)V。此外还有许多可调整分析结果格式的选项，可参考 async-profiler 的 README 文档以及 async-profiler 的 Github Discussions 等材料。

例如，以下命令中，-s 将输出中的类名称指定为简短格式，-g 显示方法的完整签名，-a 标注出 Java 方法，-l 为原生方法增加库名称，--title 为生成火焰图页面指定标题，--minwidth 将过滤火焰图中宽度为 15% 以下的帧，--reverse 将火焰图倒置。

profiler stop -s -g -a -l --title <flametitle> --minwidth 15 --reverse

生成的火焰图里的 unknown

https://github.com/jvm-profiling-tools/async-profiler/discussions/409

配置 locks/allocations 模式的阈值

当使用 lock 或 alloc event 进行 profiling 时，可以使用 --lock 或 --alloc 配置阈值，比如下列命令：

profiler start -e lock --lock 10ms
profiler start -e alloc --alloc 2m

会记录竞争时间超过 10ms 的锁（如果不指定时间单位，则使用 ns 为单位），或者以 2MB 的单位记录对内存的分配。

配置 JFR 块

当使用 JFR 作为输出格式时，可以使用 --chunksize 或 --chunktime 配置单个 JFR 块的大致容量（以 byte 为单位，默认 100 MB）和时间限制（默认值为 1 小时），比如：

profiler start -f profile.jfr --chunksize 100m --chunktime 1h

将线程按照调度策略分组

可以使用 --sched 标志选项将输出结果按照 Linux 线程调度策略分组，策略包括 BATCH/IDLE/OTHER。例如：

profiler start --sched

火焰图的倒数第二行会标记不同的调度策略。

仅用未销毁对象构建内存分析结果

使用 --live 标志选项在内存分析结果中仅保留那些在分析过程结束时仍未被 JVM 回收的对象。该选项在排查 Java 堆内存泄露问题时比较有用。

profiler start --live

配置收集 C 栈帧的方法

使用 --cstack MODE 配置收集 native 帧的方法。候选模式有 fp (Frame Pointer), dwarf (DWARF unwind info), lbr (Last Branch Record, 从 Linux 4.1 在 Haswell 可用), and no (不收集 native 栈帧).

默认情况下，C 栈帧会出现在 cpu、itimer、wall-clock、perf-events 模式中，而 Java 级别的 event 比如 alloc 和 lock 只收集 Java stack。

profiler --cstack fp

此命令将收集 native 栈帧的 Frame Pointer 信息。

当指定 native 函数执行时开始/停止 profiling

使用 --begin function 和 --end function 选项在指定 native 函数被执行时让 profiling 过程启动或终止。主要用途是分析特定的 JVM 阶段，比如 GC 和安全点。需要使用特定 JVM 实现中的 native 函数名，比如 HotSpot JVM 中的 SafepointSynchronize::begin 和 SafepointSynchronize::end。

Time-to-safepoint profiling

选项 --ttsp 实际上是 --begin SafepointSynchronize::begin --end RuntimeService::record_safepoint_synchronized 的一个别名。它是一种约束而不是独立的 event 类型。无论选择哪种 event，profiler 都可以正常工作，但只有 VM 操作和 safepoint request 之间的事件会被记录下来。

profiler start --begin SafepointSynchronize::begin --end RuntimeService::record_safepoint_synchronized
profiler --ttsp

使用 profiler 记录的 event 生成 JFR 文件

用 --jfrsync CONFIG 选项可以指定配置启动 Java Flight Recording，输出的 jfr 文件会包含所有常规的 JFR event，但采样的来源是由 profiler 提供的。

CONFIG 选项可以是 profile，表示使用在 $JAVA_HOME/lib/jfr 目录下预置的“profile”配置，也可以是自定义的 JFR 配置文件（.jfc），此选项的值采用与 JFR.start 命令的 settings 选项相同的格式。

比如，以下命令使用“profile”配置启动 JFR：

profiler start -e cpu --jfrsync profile -f combined.jfr

周期性保存结果

使用 --loop TIME 可以持续运行 profiler 并周期性保存结果。选项格式可以是具体时间 hh:mm:ss 或以秒、分钟、小时或天计算的时间间隔。需要确保指定的输出文件名中包含时间戳，否则每次输出的结果都会覆盖上次保存的结果。以下命令持续执行 profiling 并将每个小时内的记录保存到一个 jfr 文件中。

profiler start --loop 1h -f /var/log/profile-%t.jfr

`--timeout` 选项

这个选项指定 profiling 自动在多久后停止。该选项和 --loop 选项的格式一致，可以是时间点，也可以是一个时间间隔。这两个选项都是用于 start action 而不是 collect action 的。可参考 async-profiler Github Discussions 了解更多信息。

`--wall` 选项

通过 --wall 选项，可以同时进行 CPU 和 Wall Clock 的性能分析。

这种联合分析有助于更全面地识别和理解应用程序的性能瓶颈。
允许用户独立于 CPU 分析设置 Wall Clock 分析的采样间隔。比如，可以通过设置 -e cpu -i 10 --wall 200，将 CPU 采样间隔设为 10 毫秒，墙钟采样间隔设为 200 毫秒。
联合进行 CPU 和 Wall Clock 分析时，输出格式必须设置为 jfr。这一格式支持记录线程的状态信息（如 STATE_RUNNABLE 或 STATE_SLEEPING），从而区分不同类型的采样事件。

可参考 async-profiler Github pr#740 了解更多信息。

影响：

Linux 平台: 这个新功能仅在 Linux 平台上有效。macOS 上的 CPU 分析引擎已经基于 Wall clock 模式，因此没有额外的收益。性能开销: 启用 Wall clock 分析会增加性能开销，因此在同时分析 CPU 和 Wall clock 时，建议增加 Wall clock 的间隔。

profiler start -e cpu -i 10 --wall 100 -f out.jfr

14 KiB Raw Blame History Unescape Escape