{"id":931,"date":"2020-03-25T00:00:00","date_gmt":"2020-03-25T00:00:00","guid":{"rendered":"https:\/\/en.pingcap.com\/blog\/quickly-find-rust-program-bottlenecks-online-using-a-go-tool\/"},"modified":"2025-03-04T06:08:38","modified_gmt":"2025-03-04T14:08:38","slug":"quickly-find-rust-program-bottlenecks-online-using-a-go-tool","status":"publish","type":"post","link":"https:\/\/www.pingcap.com\/ko\/blog\/quickly-find-rust-program-bottlenecks-online-using-a-go-tool\/","title":{"rendered":"Quickly Find Rust Program Bottlenecks Online Using a Go Tool"},"content":{"rendered":"

Profiling large Rust<\/a> applications online is difficult. Current profilers are not up to the job.<\/p>\n

When we need to analyze a Rust program’s performance, we often think about perf<\/a>. To use perf, we need to:<\/p>\n

    \n
  1. Install a complete perf program to sample stack traces.<\/li>\n
  2. Use a set of script tools to process the file obtained by sampling.<\/li>\n
  3. Visualize the output of the processing result in the previous step.<\/li>\n<\/ol>\n

    However, perf doesn’t perfectly support programs written in Rust. For example, it doesn’t understand Rust’s closures. Therefore, symbols for the stack information in the visualization are complex.<\/p>\n

    To collect profiling statistics for Rust programs like TiKV<\/a>, we developed pprof-rs<\/a>, which samples, analyzes, and visualizes performance data in one step. We integrated pprof-rs in TiKV’s status_server<\/code>, which outputs monitoring information.<\/p>\n

    Because pprof-rs uses the same data format as the Go tool pprof<\/a>, we can use pprof, to visualize TiKV’s profiling data. This makes it easier for developers and online users to find TiKV’s performance bottlenecks.<\/p>\n

    In this post, I’ll share how we use pprof to visualize TiKV’s profiling data to help quickly locate TiKV’s performance bottlenecks online. If you also write Rust programs, you can introduce pprof-rs into your projects to help analyze your programs’ performance online.<\/p>\n

    <\/span>Why the protobuf format?<\/span><\/h2>\n

    pprof<\/a> is a tool that analyzes and visualizes profiling data. It profiles data in the Protocol Buffers<\/a> (protobuf) format. Protobuf is Google’s data interchange format and helps serialize structured data.<\/p>\n

    If we want to obtain detailed profiling data for a comprehensive analysis or use other community tools for profiling diagnosis, a program-readable file format is essential. pprof-rs outputs files in the protobuf format. Thus, we can use other tools that depend on this format for profiling analysis.<\/p>\n

    <\/span>How to use pprof to visualize a Rust program’s profiling data<\/span><\/h2>\n

    TiKV is a distributed, transactional, key-value database written in Rust. Taking it as an example, let’s see how to use pprof to visualize a Rust program’s profiling data:<\/p>\n

    Note:<\/strong><\/p>\n

    Before you start, make sure that you’ve installed the following in the environment:<\/p>\n