Lib.rs

Pyroscope Profiler

Pyroscope Profiler for Rust. Profile your Rust applications.

You may be looking for:

• An overview of Pyroscope
• Crate Documentation
• Examples
• Release notes
• Pyroscope CLI

Table of Contents

• Quick Start
• Pyroscope Server
• Multi-Threading
• Profiling Backends
• Limitations
• Getting Help
• License

Quick Start

Add this to your Cargo.toml:

[dependencies]
pyroscope = "0.5.4"
pyroscope_pprofrs = "0.2"

Include Pyroscope and pprof-rs dependencies:

use pyroscope::PyroscopeAgent;
use pyroscope_pprofrs::{pprof_backend, PprofConfig};

Configure the Pyroscope agent:

 let agent =
     PyroscopeAgent::builder("http://localhost:4040", "myapp-profile")
     .backend(pprof_backend(PprofConfig::new().sample_rate(100)))
     .build()?;

Profile your code:

 let agent_running = agent.start()?;

 // Computation to profile 

 let agent_ready = agent_running.stop()?;
 agent_ready.shutdown();

Pyroscope Server

The Pyroscope Agent send the profiling data to a Pyroscope Server. You need to have a Pyroscope Server running in order to consume and visualize this data. It's not possible, currently, to forward the data to another endpoint.

Multi-Threading

The Pyroscope Agent and the pprof-rs backend can profile and report data from a multi-threaded program. pprof-rs, however, does not track child-processes and thus profiling is limited to a single process.

Profiling Backends

The Pyroscope Agent doesn't do any profiling. The agent role is to orchestrate a profiling backend, and report the profiling data to the Pyroscope Server. The Agent can support external backends (in fact, all current backends are independent crates) and you can make your own. Backends can also be used seperately. The currently available backends are:

• pprof-rs: Rust profiler. A wrapper around pprof-rs.
• rbspy: Ruby Profiler. A wrapper around rbspy.
• py-spy: Python Profiler. A wrapper around py-spy.

Native Integration

Pyroscope can be used directly from your projects with native integration. No agent or external programs are required.

• Python: Python Package. Readme - Documentation
• Ruby: Ruby Gem. Readme - Documentation

Limitations

• Backend: The Pyroscope Agent uses pprof-rs as a backend. As a result, the limitations for pprof-rs also applies.
• Tagging: As of 0.5.0, the Pyroscope Agent support tagging within threads. Check the Tags and Multi-Thread examples for usage.
• Timer: epoll (for Linux) and kqueue (for macOS) are required for a more precise timer.
• Shutdown: The Pyroscope Agent might take some time (usually less than 10 seconds) to shutdown properly and drop its threads. For a proper shutdown, it's recommended that you run the shutdown function before dropping the Agent.

Getting help

You can read the Docs or check the examples for detailed usage of the library. You can also join the Slack channel if you have questions.

Major Contributors

We'd like to give a big thank you to the following contributors who have made significant contributions to this project:

• Abid Omar
• Anatoly Korniltsev
• Bernhard Schuster

License

Pyroscope is distributed under the Apache License (Version 2.0).

See LICENSE for details.