Crate pprof

source ·
Expand description

pprof-rs is an integrated profiler for rust program.

This crate provides a programable interface to start/stop/report a profiler dynamically. With the help of this crate, you can easily integrate a profiler into your rust program in a modern, convenient way.

A sample usage is:

let guard = pprof::ProfilerGuard::new(100).unwrap();

Then you can read report from the guard:

if let Ok(report) = guard.report().build() {
   println!("report: {:?}", &report);
};

More configuration can be passed through ProfilerGuardBuilder:

let guard = pprof::ProfilerGuardBuilder::default().frequency(1000).blocklist(&["libc", "libgcc", "pthread", "vdso"]).build().unwrap();

The frequency means the sampler frequency, and the blocklist means the profiler will ignore the sample whose first frame is from library containing these strings.

Skipping libc, libgcc and libpthread could be a solution to the possible deadlock inside the _Unwind_Backtrace, and keep the signal safety. The dwarf information in “vdso” is incorrect in some distributions, so it’s also suggested to skip it.

You can find more details in README.md

Modules

Structs

  • Collector
  • Frames
    A representation of a backtrace. thread_name and thread_id was got from pthread_getname_np and pthread_self. frames is a vector of symbols.
  • HashCounter
  • ProfilerGuard
    RAII structure used to stop profiling when dropped. It is the only interface to access profiler.
  • ProfilerGuardBuilder
  • Report
    The final presentation of a report which is actually an HashMap from Frames to isize (count).
  • ReportBuilder
    A builder of Report and UnresolvedReport. It builds report from a running Profiler.
  • Symbol
    Symbol is a representation of a function symbol. It contains name and addr of it. If built with debug message, it can also provide line number and filename. The name in it is not demangled.
  • UnresolvedReport
    The presentation of an unsymbolicated report which is actually an HashMap from UnresolvedFrames to isize (count).

Enums

Constants

  • MAX_DEPTH
    Define the MAX supported stack depth. TODO: make this variable mutable.
  • MAX_THREAD_NAME
    Define the MAX supported thread name length. TODO: make this variable mutable.

Functions

Type Definitions