bradoctech / pyroscope Goto Github PK

On 2023-03-15, Grafana Labs acquired Pyroscope.

The teams and codebases of both Grafana Phlare and Pyroscope are merging into Grafana Pyroscope.

Grafana Pyroscope is a new project. It will take some time to merge codebases and get to the first release.

Feel free to use the information from the original Pyroscope project until that time.

Grafana 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

• 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

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

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:

Golang Documentation Examples	Java Documentation Examples	Python Documentation Examples	Ruby Documentation Examples	Rust Documentation Examples
NodeJS Documentation Examples	Dotnet Documentation Examples	eBPF Documentation Examples	PHP Documentation Examples	Grafana Documentation Examples

Pyroscope also supports several third-party integrations notably:

• Grafana Plugin
• Jaeger UI
• OTel Golang (tracing)
• AWS Lambda Extension

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:

• Public Roadmap
• Getting Started
• Deployment Guide
• Developer Guide

You can download the latest version of pyroscope for macOS, linux and Docker from our Downloads page.

• Go (via pprof)
• Python (via py-spy)
• Ruby (via rbspy)
• Linux eBPF (via profile.py from bcc-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.

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

To start contributing, check out our Contributing Guide