README ¶

Pyroscope

Go Tests Status JS Tests Status Go Report Apache 2 License Latest release DockerHub GoDoc

Website • Docs • Demo • Examples • Slack

Read this in other languages.

中文 (Simplified)

Pyroscope is an open source continuous profiling platform. It will help you:

  • Find performance issues in your code
  • Resolve issues with high CPU utilization
  • Understand the call tree of your application
  • Track changes over time

🔥 Pyroscope Live Demo 🔥

Pyroscope GIF 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
  • Support for Go, Ruby and Python

Try Pyroscope locally in 3 steps:

# install pyroscope
brew install pyroscope-io/brew/pyroscope

# start pyroscope server:
pyroscope server

# in a separate tab, start profiling your app:
pyroscope exec python manage.py runserver # If using Python
pyroscope exec rails server               # If using Ruby

# If using Pyroscope cloud add flags for server address and auth token
# pyroscope exec -server-address "https://your_company.pyroscope.cloud" -auth-token "ps-key-1234567890" python manage.py runserver

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:

Deployment Diagram

Deployment Diagram

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.py from bcc-tools)
  • PHP (via phpspy)
  • .NET (via dotnet trace)
  • Java (coming soon)

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!

Documentation ¶

The Go Gopher

There is no documentation for this package.

Source Files ¶

Directories ¶

Path Synopsis
cmd
examples
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.
cli
util/hyperloglog
Package hyperloglog wraps github.com/clarkduvall/hyperloglog with mutexes
Package hyperloglog wraps github.com/clarkduvall/hyperloglog with mutexes
util/metrics
Package metrics is a temporary solution for handling prometheus metrics.
Package metrics is a temporary solution for handling prometheus metrics.
scripts
Package tools is empty.
Package tools is empty.