README
ΒΆ
Website β’ Docs β’ Demo β’ Examples β’ Slack
Read this in other languages.
What is Pyroscope?
Pyroscope is an open source continuous profiling platform. It will help you:
- Find performance issues and bottlenecks in your code
- Resolve issues with high CPU utilization
- Understand the call tree of your application
- Track changes over time
π₯ Pyroscope Live Demo π₯
Features
- Can store years of profiling data from multiple applications
- You can look at years of data at a time or zoom in on specific events
- Low CPU overhead
- Efficient compression, low disk space requirements
- Snappy UI
Add Pyroscope Server locally in 2 steps:
Pyroscope supports all major architectures and is very easy to install. for example here is how you install on a mac:
# install pyroscope
brew install pyroscope-io/brew/pyroscope
# start pyroscope server:
pyroscope server
Send data to server via Pyroscope agent (language specific)
For more documentation on how to add the Pyroscope agent to your code see the agent documentation on our website.
- Golang Agent (Push)
- Golang Agent (Pull)
- Python Agent (pip)
- Ruby Agent (gem)
- eBPF Agent
- PHP Agent
- .NET Agent
Example Code
We also have language-specific examples (using Docker) of how to run the server and agent together
- Golang Example
- Python Pip Example
- Ruby Gem Example
- Grafana Example
- Java Example
- PHP example
- .NET Example
Deployment Diagram
Documentation
For more information on how to use Pyroscope with other programming languages, install it on Linux, or use it in production environment, check out our documentation:
Downloads
You can download the latest version of pyroscope for macOS, linux and Docker from our Downloads page.
Supported Integrations
- Ruby (via
rbspy) - Python (via
py-spy) - Go (via
pprof) - Linux eBPF (via
profile.pyfrombcc-tools) - PHP (via
phpspy) - .NET (via
dotnet trace) - Java (via
async-profiler) - Rust (in progress via
pprof-rs) - Node (seeking contributors)
Let us know what other integrations you want to see in our issues or in our slack.
Credits
Pyroscope is possible thanks to the excellent work of many people, including but not limited to:
- Brendan Gregg β inventor of Flame Graphs
- Julia Evans β creator of rbspy β sampling profiler for Ruby
- Vladimir Agafonkin β creator of flamebearer β fast flamegraph renderer
- Ben Frederickson β creator of py-spy β sampling profiler for Python
- Adam Saponara β creator of phpspy β sampling profiler for PHP
- Alexei Starovoitov, Brendan Gregg, and many others who made BPF based profiling in Linux kernel possible
Contributing
To start contributing, check out our Contributing Guide
Thanks to the contributors of Pyroscope!
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
benchmark
|
|
|
cmd
|
|
|
examples
|
|
|
hacks
|
|
|
pkg
|
|
|
agent/pprof
Package pprof writes runtime profiling data in the format expected by the pprof visualization tool.
|
Package pprof writes runtime profiling data in the format expected by the pprof visualization tool. |
|
agent/profiler
Package profiler is a public API golang apps should use to send data to pyroscope server.
|
Package profiler is a public API golang apps should use to send data to pyroscope server. |
|
agent/spy
Package spy contains an interface (Spy) and functionality to register new spies
|
Package spy contains an interface (Spy) and functionality to register new spies |
|
analytics
Package analytics deals with collecting pyroscope server usage data.
|
Package analytics deals with collecting pyroscope server usage data. |
|
build
Package build contains build-related variables set at compile time.
|
Package build contains build-related variables set at compile time. |
|
util/hyperloglog
Package hyperloglog wraps github.com/clarkduvall/hyperloglog with mutexes
|
Package hyperloglog wraps github.com/clarkduvall/hyperloglog with mutexes |
|
scripts
|
|
|
Package tools is empty.
|
Package tools is empty. |