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
- Use high-cardinality tags/labels to analyze your application
- Resolve issues with high CPU utilization
- Track down memory leaks
- Understand the call tree of your application
- Auto-instrument your code to link profiling data to traces
π₯ Pyroscope Live Demo π₯
Features
- Minimal CPU overhead
- Efficient compression, low disk space requirements
- Can handle high-cardinality tags/labels
- Calculate the performance "diff" between various tags/labels and time periods
- Can store years of profiling data from multiple applications
- Advanced analysis 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 or find language specific examples and documentation below:
Deployment Diagram
Third-Party Integrations
Pyroscope also supports several third-party integrations notably:
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
- Go (via
pprof) - Python (via
py-spy) - Ruby (via
rbspy) - Linux eBPF (via
profile.pyfrombcc-tools) - Java (via
async-profiler) - Rust (via
pprof-rs) - .NET (via
dotnet trace) - PHP (via
phpspy) - Node
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
- Jamie Wong β creator of speedscope β interactive flamegraph visualizer
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. |
|
api/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
build
Package build contains build-related variables set at compile time.
|
Package build contains build-related variables set at compile time. |
|
fs
Package fs contain file system helpers
|
Package fs contain file system helpers |
|
parser
Package parser deals with parsing various incoming formats
|
Package parser deals with parsing various incoming formats |
|
scrape/discovery/http
Package http discovery Copyright 2021 The Prometheus Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
Package http discovery Copyright 2021 The Prometheus Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. |
|
util/arenahelper
Package arenahelper ...
|
Package arenahelper ... |
|
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. |