pyroscope

module
v1.0.0-rc.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 18, 2023 License: AGPL-3.0

README ΒΆ

Go Tests Status JS Tests Status Go Report FOSSA Status Latest release DockerHub GoDoc

News

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

The teams and codebases Grafana Phlare and Pyroscope have merged into Grafana Pyroscope. The next branch reflects the current and ongoing developent of Grafana Pyroscope and all enhancement/fixes will and should be merged into it.

We plan to release Pyroscope 1.0 in the near future (by mid-September 2023) -- thanks for your patience!

Feel free to use the information from the original Pyroscope project until that time, which can still be found the main branch.

What is Grafana Pyroscope?

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

πŸ”₯ Pyroscope Live Demo πŸ”₯

Pyroscope GIF 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:


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

Deployment Diagram

agent_server_diagram_11-01

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.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.

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
api module
cmd
profilecli command
pyroscope command
ebpf module
examples
adhoc/pull command
lidia module
pkg
api
cfg
og/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
og/build
Package build contains build-related variables set at compile time.
Package build contains build-related variables set at compile time.
og/util/arenahelper
Package arenahelper ...
Package arenahelper ...
phlaredb
nolint unused
nolint unused
phlaredb/tsdb
originally from https://github.com/cortexproject/cortex/blob/868898a2921c662dcd4f90683e8b95c927a8edd8/pkg/ingester/index/index.go but modified to support sharding queries.
originally from https://github.com/cortexproject/cortex/blob/868898a2921c662dcd4f90683e8b95c927a8edd8/pkg/ingester/index/index.go but modified to support sharding queries.
util/gziphandler
Package gziphandler mirrors the package github.com/nytimes/gziphandler until https://github.com/nytimes/gziphandler/pull/112 is merged.
Package gziphandler mirrors the package github.com/nytimes/gziphandler until https://github.com/nytimes/gziphandler/pull/112 is merged.
tools
doc-generator command
yaml-to-json command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL