Tool to convert Linux perf files to the profile.proto format used by pprof
C++ Python Other
Switch branches/tags
Nothing to show
Clone or download
Latest commit fdc6584 Aug 2, 2018

README.md

Introduction

The perf_to_profile binary can be used to turn a perf.data file, which is generated by the linux profiler, perf, into a profile.proto file which can be visualized using the tool pprof.

For details on pprof, see https://github.com/google/pprof

THIS IS NOT AN OFFICIAL GOOGLE PRODUCT

Prerequisites to build

  • Install dependencies

    sudo apt-get -y install g++ git libelf-dev libcap-dev
    

Compile and Test

To install all dependences and build the binary, run the following commands. These were tested on Ubuntu 14.04 LTS:

Compile

  • Install bazel by following the instructions here.

  • Install dependencies and build perf_to_profile using bazel

    git clone https://github.com/google/perf_data_converter.git
    cd perf_data_converter
    bazel build src:perf_to_profile
    

Place the perf_to_profile binary in a place accessible from your PATH (e.g. /usr/local/bin).

Running tests

  • There are a small number of tests that verify the basic functionality. To run these, after successful compilation, run:

    bazel test src:all
    bazel test src/quipper:all
    

Note: Executables generated using bazel build are available under the directory bazel-bin/.

Usage

  • Profile a command using perf, for example:

    perf record /bin/ls
    
  • Recent versions of pprof will automatically invoke perf_to_profile:

    pprof -web perf.data
    

Compile and test with Makefiles

Compile

  • SUPPORT FOR MAKE FILES WILL BE REMOVED AFTER MAY 2018

  • These were tested on Debian GNU/Linux 8 (jessie):

    sudo apt-get -y install autoconf automake libssl-dev make libtool pkg-config
    git clone --recursive https://github.com/google/perf_data_converter.git
    cd perf_data_converter/src
    make perf_to_profile
    
  • If you already have protocol buffers and googletest installed on your system, you can compile using your local packages with the following commands:

    sudo apt-get -y install autoconf automake libssl-dev make libtool pkg-config
    git clone https://github.com/google/perf_data_converter.git
    cd perf_data_converter/src
    make perf_to_profile
    

Running tests

  • To run test, after successful compilation, run:
make check clean
make check clean -C quipper/ -f Makefile.external

Contribution

We appreciate your help!

Note that perf data converter and quipper projects do not use GitHub pull requests, and that we use the issue tracker for bug reports.