README
¶
🎉 Announcement: The new Explore Profiles UI is here!
We are thrilled to announce the launch of the Explore Profiles UI, a brand-new way to explore and analyze your profiling data—now available as part of the Grafana Explore Apps suite! This new app brings you a queryless, intuitive experience for visualizing your profiling data, simplifying the entire process without the need to write complex queries.
https://github.com/user-attachments/assets/4db19ec7-86f3-4701-8f5f-9b7ffcebd49c
What is Grafana Pyroscope?
Grafana Pyroscope is a continuous profiling platform designed to surface performance insights from your applications, helping you optimize resource usage such as CPU, memory, and I/O operations. With Pyroscope, you can both proactively and reactively address performance bottlenecks across your system.
The typical use cases are:
- Proactive: Reducing resource consumption, improving application performance, or preventing latency issues.
- Reactive: Quickly resolving incidents with line-level detail and debugging active CPU, memory, or I/O bottlenecks.
Pyroscope provides powerful tools to give you a comprehensive view of your application's behavior while allowing you to drill down into specific services for more targeted root cause analysis.
How Does Pyroscope Work?
Pyroscope consists of three main components:
- Pyroscope Server: The server component that stores and processes profiling data.
- Pyroscope SDKs(push) or Grafana alloy(pull) : The client-side part of Pyroscope that collects profiling data from your applications and sends it to the server.
- Explore Profiles UI: A queryless, intuitive UI for visualizing and analyzing profiling data.
Pyroscope Live Demo
Quick Start: Run Pyroscope server locally
Homebrew
brew install pyroscope-io/brew/pyroscope
brew services start pyroscope
Docker
docker run -it -p 4040:4040 grafana/pyroscope
For more documentation on how to configure Pyroscope server, see our server documentation.
Quick Start: Run Explore Profiles UI in Grafana
Grafana Cloud
The app UI and server are both installed and running auomatically -- just start sending data!
Grafana OSS
You can run the Explore profiles UI in Grafana by installing the plugin from the Grafana Plugin Directory
For more information, check out the Explore Profiles README
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:
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:
Supported Languages
Our documentation contains the most recent list of supported languages and also an overview over what profiling types are supported per language.
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 flame graph 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 flame graph visualizer
Contributing
To start contributing, check out our Contributing Guide
Thanks to the contributors of Pyroscope!
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
cmd
|
|
|
ebpf
module
|
|
|
examples
|
|
|
pkg
|
|
|
compactor
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/grafana/mimir/blob/main/pkg/compactor/compactor.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Cortex Authors.
|
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/grafana/mimir/blob/main/pkg/compactor/compactor.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Cortex Authors. |
|
frontend/dot/graph
Package graph collects a set of samples into a directed graph.
|
Package graph collects a set of samples into a directed graph. |
|
frontend/dot/measurement
Package measurement export utility functions to manipulate/format performance profile sample values.
|
Package measurement export utility functions to manipulate/format performance profile sample values. |
|
frontend/dot/report
Package report summarizes a performance profile into a human-readable report.
|
Package report summarizes a performance profile into a human-readable report. |
|
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/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
CopyFile copies the contents of the file named src to the file named by dst.
|
CopyFile copies the contents of the file named src to the file named by dst. |
|
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. |