CPU火焰图常用工具

Love The Way You Lie 2022-11-03 10:49 283阅读 0赞

# CPU火焰图 #

关于性能分析

*  On-CPU火焰图: 基于线程在CPU执行上耗时采样，可以直观地查看线程花费在CPU上的时间分布
 *  Off-CPU火焰图: 基于线程在CPU等待(I/O、锁、中断等原因)上耗时采样，可以直观地查看线程花费在阻塞上的时间分布

一篇关于off-cpu火焰图的入门引导性文章：[offcpuanalysis][]

> Off-CPU analysis is complementary to CPU analysis, so that 100% of thread time can be understood. This method also differs from tracing techniques that instrument applications functions that commonly block, since this method targets the kernel scheduler’s notion of blocking, which is a convenient catch-all.
> 
> Threads can leave CPU for a number of reasons, including I/O and locks, but also some that are unrelated to the current thread’s execution, including involuntary context switching due to high demand for CPU resources, and interrupts. Whatever the reason, if this occurs during a workload request (a synchronous code-path), then it is introducing latency.

# 常用工具 #

## arthas ##

[arthas][]是Alibaba开源的Java诊断工具，其中整合了很多实用的工具，例如查看当前JVM的线程堆栈信息、查看和修改JVM的系统属性、方法执行数据观测、生成火焰图等。最大的优点是对监控应用无代码侵入，也不需要重启监控应用或者添加启动参数就可以随意attach到目标JVM进程然后进行各种操作。

此处重点提到的是arthas中的[profiler][]功能，实际上是对[async-profiler][]的封装，可以对JVM应用进行采样后输出各种类型的火焰图。

### 使用教程 ###

1.  启动arthas

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

1.  启动profiler采样

# 基于CPU使用率采样(适用于CPU密集型)
    $ profiler start
    Started [cpu] profiling

# 基于样本采样,可估算耗时(适用于IO密集型)
    $ profiler start -e wall
    Started [wall] profiling

1.  获取已采集的sample的数量

$ profiler getSamples
    23

1.  查看profiler状态

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

1.  生成svg格式结果

$ profiler stop
    profiler output file: /tmp/demo/arthas-output/20191125-135546.svg
    OK

### 采样事件 ###

`async-profiler`支持对多种事件做采样分析，例如`cpu`、`alloc`、`lock`、`cache-misses`等，常用的采样事件为`cpu`和`wall`。其中火焰图采样未指定事件时默认对`cpu`事件进行采样，即On-CPU火焰图，仅包含JVM在CPU执行时的采样，而不包含CPU等待时的采样。

如果需要分析IO密集型应用，比较适合对`wall`事件进行采样，如下官方描述，`wall`事件会对所有任意状态的线程进行采样，既包含CPU执行时的采样，也包含了CPU等待时的采样，可以用来更显著地分析线程在各个方法上的耗时分布。

> `-e wall` option tells async-profiler to sample all threads equally every given period of time regardless of thread status: Running, Sleeping or Blocked. For instance, this can be helpful when profiling application start-up time.

### demo ###

@RestController
    @RequestMapping
    public class IndexController { 
    
        @GetMapping("/")
        public String index() throws InterruptedException { 
            long start = System.currentTimeMillis();
            cpuHandler();
            long time1 = System.currentTimeMillis();
            timeHandler();
            long time2 = System.currentTimeMillis();
            normalHandler();
            long time3 = System.currentTimeMillis();
    
            return String.format("%d %d %d", time1 - start, time2 - time1, time3 - time2);
        }
    
        private int cpuHandler() { 
            int value = 0;
            int max = (int)(Math.random() * 100_000_000);
            for (int i = 0; i < max; i++) { 
                value += i;
            }
            return value;
        }
    
        private void timeHandler() throws InterruptedException { 
            Thread.sleep(10);
        }
    
        private void normalHandler() { 
            Random random = new Random();
            random.nextInt(100);
        }
    }

*  `cpu`事件采样

![在这里插入图片描述][20210227162812385.png]

由图可以明细的看出来，`index`方法中`cpuHandler`事件采样占比最高，即On-CPU中`cpuHandler`方法占用的CPU最高。如果因为应用占用CPU消耗高，需要进行优化，那么通过该火焰图很容易分析出来需要对`cpuHandler`方法优化来降低CPU消耗。

*  `wall`事件采样

![在这里插入图片描述][20210227162827782.png]

由图可以明细的看出来，`index`方法中`timeHandler`事件采样占比最高，即`timeHandler`方法占用线程耗时时间最高。如果因为`index`方法耗时较长，需要进行优化，那么通过该火焰图很容易分析出来需要对`timeHandler`方法优化来降低线程耗时时间。

## pprof ##

[pprof][]是Golang用于可视化和分析配置文件数据的工具。

pprof读取profile.proto格式的分析样本的集合，并生成报告以可视化并帮助分析数据。它可以生成文本和图形报告。

### 使用教程 ###

curl -so on-cpu.pprof http://127.0.0.1:9090/debug/pprof/profile?seconds=10
    go tool pprof -http=0.0.0.0:6061 ./on-cpu.pprof

curl -so pprof.trace http://127.0.0.1:9090/debug/pprof/trace?seconds=10
    go tool trace --pprof=sync pprof.trace > off-cpu.pprof
    go tool pprof -http=0.0.0.0:6061 ./off-cpu.pprof

### 采样事件 ###

pprof中的`profile`事件实际上就是CPU执行上耗时采样，适合用于分析CPU密集型的耗时分布，或者用于分析应用CPU性能的执行荷载分布。

而pprof中的`trace`事件虽然官方文档描述如下说是追踪事件，但实际测试下来有点像是Off-CPU的时间分布，但又有有些区别，例如最简单的`time.Sleep()`睡眠时间并未采集到该事件中。

> The package also exports a handler that serves execution trace data for the “go tool trace” command

### demo ###

package main
    
    import (
    	"fmt"
    	"log"
    	"math/rand"
    	"net/http"
    	_ "net/http/pprof"
    	"time"
    )
    
    func main() { 
    	http.HandleFunc("/", handler)
    	err := http.ListenAndServe(":9090", nil)
    	if err != nil { 
    		log.Fatal("ListenAndServe: ", err)
    	}
    }
    
    func handler(w http.ResponseWriter, r *http.Request) { 
    	start := time.Now()
    	cpuHandler()
    	time1 := time.Now()
    	sleepHandler()
    	time2 := time.Now()
    	normalHandler()
    	time3 := time.Now()
    
    	response := fmt.Sprintf("%v, %v, %v", time1.Sub(start), time2.Sub(time1), time3.Sub(time2))
    	_, _ = fmt.Fprint(w, response)
    }
    
    func cpuHandler() (value int) { 
    	for i := 0; i < 10_000_000; i++ { 
    		value += i
    	}
    	return
    }
    
    func sleepHandler() { 
    	_, _ = http.Get("http://192.168.50.150")
    }
    
    func normalHandler() { 
    	rand.Int31n(100)
    }

*  `profile`事件采样

![在这里插入图片描述][2021022716285668.png]

由图可以明细的看出来，`handler`方法中`cpuHandler`事件采样占比最高，即On-CPU中`cpuHandler`方法占用的CPU最高。如果因为应用占用CPU消耗高，需要进行优化，那么通过该火焰图很容易分析出来需要对`cpuHandler`方法优化来降低CPU消耗。

*  `trace`事件采样

![在这里插入图片描述][20210227162916811.png]

由图可以明细的看出来，`handler`方法中`sleepHandler`事件采样占比最高，即Off-CPU中`sleepHandler`方法占用的CPU等待时间最高。如果因为handler方法耗时久，需要进行优化，那么通过该火焰图很容易分析出来需要优先对`sleepHandler`方法优化来降低CPU等待耗时。

但由于`trace`事件采样的局限性，不能展示出线程的耗时分布，因此还需要更多的信息来分析handler方法的耗时原因。

### 常见错误 ###

当对采集数据进行可视化分析时，如果控制台或者WEB界面输出如下错误，则说明当前机器需要安装`graphviz`依赖。对于centos快速安装依赖的方式为执行命令：`yum install -y graphviz`。

[root@localhost ~]# go tool pprof -http=0.0.0.0:6061 ./pprof
    Serving web UI on http://0.0.0.0:6061
    http://0.0.0.0:6061
    Failed to execute dot. Is Graphviz installed?
    exec: "dot": executable file not found in $PATH

Could not execute dot; may need to install graphviz.

## fgprof ##

基于Golang官方提供的pprof的内置采集事件只能采集On-CPU时间，第三方库实现了类似于pprof的工具[fgprof][]，可以对Golang的On-CPU和Off-CPU的性能一起提供分析。

### 使用教程 ###

curl -so fgprof.pprof http://127.0.0.1:9090/debug/fgprof?seconds=10
    go tool pprof -http=0.0.0.0:6061 ./fgprof.pprof

### 采集事件 ###

> fgprof is a sampling Go profiler that allows you to analyze On-CPU as well as Off-CPU (e.g. I/O) time together.
> 
> Go’s builtin sampling CPU profiler can only show On-CPU time, but it’s better than fgprof at that. Go also includes tracing profilers that can analyze I/O, but they can’t be combined with the CPU profiler.
> 
> fgprof is designed for analyzing applications with mixed I/O and CPU workloads. This kind of profiling is also known as wall-clock profiling.

fgprof的采集事件与arthas中的`wall`事件类似，都是直接对所有状态的goroutine进行采样，既包含CPU执行时的采样，也包含了CPU等待时的采样，可以用来更显著地分析线程在各个方法上的耗时分布。

### demo ###

package main
    
    import (
    	"fmt"
    	"github.com/felixge/fgprof"
    	"log"
    	"math/rand"
    	"net/http"
    	"time"
    )
    
    func main() { 
    	http.HandleFunc("/", handler)
    	http.Handle("/debug/fgprof", fgprof.Handler())
    	err := http.ListenAndServe(":9090", nil)
    	if err != nil { 
    		log.Fatal("ListenAndServe: ", err)
    	}
    }
    
    func handler(w http.ResponseWriter, r *http.Request) { 
    	start := time.Now()
    	cpuHandler()
    	time1 := time.Now()
    	sleepHandler()
    	time2 := time.Now()
    	normalHandler()
    	time3 := time.Now()
    
    	response := fmt.Sprintf("%v, %v, %v", time1.Sub(start), time2.Sub(time1), time3.Sub(time2))
    	_, _ = fmt.Fprint(w, response)
    }
    
    func cpuHandler() (value int) { 
    	for i := 0; i < 10_000_000; i++ { 
    		value += i
    	}
    	return
    }
    
    func sleepHandler() { 
    	_, _ = http.Get("http://192.168.50.150")
    }
    
    func normalHandler() { 
    	rand.Int31n(100)
    }

*  `fgprof`采样

![在这里插入图片描述][20210227162945299.png]

由图可以明细的看出来，`handler`方法中`sleepHandler`事件采样占比最高，即`sleepHandler`方法占用的线程耗时时间最多。如果因为handler方法耗时久，需要进行优化，那么通过该火焰图很容易分析出来需要优先对`sleepHandler`方法优化来降低线程耗时。

## perf ##

### 采集事件 ###

### 使用教程 ###

1.  数据采样

// On-CPU采样数据
    perf record -g

// Off-CPU采样数据
    perf record -g -e 'sched:sched_switch' -e 'sched:sched_stat_sleep' -e 'sched:sched_process_exit'

1.  生成火焰图

git clone https://github.com/brendangregg/FlameGraph

perf script | ./FlameGraph/stackcollapse-perf.pl | ./FlameGraph/flamegraph.pl > perf.svg

### demo ###

*  On-CPU采样

![在这里插入图片描述][20210227163025677.png]

*  Off-CPU采样

![在这里插入图片描述][20210227163047837.png]

[offcpuanalysis]: http://www.brendangregg.com/offcpuanalysis.html
[arthas]: https://github.com/alibaba/arthas
[profiler]: https://arthas.aliyun.com/doc/profiler.html
[async-profiler]: https://github.com/jvm-profiling-tools/async-profiler
[20210227162812385.png]: /images/20221024/652a0546b46a4983938bf7bd770a42e9.png
[20210227162827782.png]: /images/20221024/e47e15d1aa6645b394c290ac131e818e.png
[pprof]: https://golang.org/pkg/net/http/pprof/
[2021022716285668.png]: /images/20221024/08ddea86628347c393c72b1b285cd81b.png
[20210227162916811.png]: /images/20221024/fa9b9fefcdc244e4a12e98f61b2b7ebc.png
[fgprof]: https://github.com/felixge/fgprof
[20210227162945299.png]: /images/20221024/6bedd74d293c4f14951106f65d104ffa.png
[20210227163025677.png]: /images/20221024/c58be01fbab043b49aabd725489ffb79.png
[20210227163047837.png]: /images/20221024/cb7a0765a25c4f7982e20dd6d4a5d771.png