# pyroscope **Repository Path**: glaye/pyroscope ## Basic Information - **Project Name**: pyroscope - **Description**: No description available - **Primary Language**: Unknown - **License**: AGPL-3.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-03-05 - **Last Updated**: 2026-03-05 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

Pyroscope

[![ci](https://github.com/grafana/pyroscope/actions/workflows/test.yml/badge.svg)](https://github.com/grafana/pyroscope/actions/workflows/test.yml) [![JS Tests Status](https://github.com/grafana/pyroscope/workflows/JS%20Tests/badge.svg)](https://github.com/grafana/pyroscope/actions?query=workflow%3AJS%20Tests) [![Go Report](https://goreportcard.com/badge/github.com/grafana/pyroscope)](https://goreportcard.com/report/github.com/grafana/pyroscope) [![License: AGPLv3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fgrafana%2Fpyroscope.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fgrafana%2Fpyroscope?ref=badge_shield) [![Latest release](https://img.shields.io/github/release/grafana/pyroscope.svg)](https://github.com/grafana/pyroscope/releases) [![DockerHub](https://img.shields.io/docker/pulls/grafana/pyroscope.svg)](https://hub.docker.com/r/grafana/pyroscope) [![GoDoc](https://godoc.org/github.com/grafana/pyroscope?status.svg)](https://godoc.org/github.com/grafana/pyroscope) ## πŸŽ‰ **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? ![deployment_diagram](https://grafana.com/media/docs/pyroscope/pyroscope_client_server_diagram_09_18_2024.png) 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](https://play.grafana.org/a/grafana-pyroscope-app/) [![Pyroscope GIF Demo](https://github.com/user-attachments/assets/2faeb985-f2b6-4311-ad29-e318e850c025)](https://play.grafana.org/a/grafana-pyroscope-app/) --- ## **Quick Start: Run Pyroscope server locally** ### Homebrew ```sh brew install pyroscope-io/brew/pyroscope brew services start pyroscope ``` ### Docker ```sh docker run -it -p 4040:4040 grafana/pyroscope ``` For more documentation on how to configure Pyroscope server, see [our server documentation](https://grafana.com/docs/pyroscope/latest/configure-server/). ## **Quick Start: Run Explore Profiles UI in Grafana** image ### Grafana Cloud The app UI and server are both installed and running automatically -- just start sending data! ### Grafana OSS You can run the Explore profiles UI in Grafana by installing the plugin from the [Grafana Plugin Directory](https://grafana.com/grafana/plugins/grafana-pyroscope-app/) For more information, check out the [Explore Profiles README](https://github.com/grafana/explore-profiles) ## 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: * [Getting Started](https://grafana.com/docs/pyroscope/latest/get-started/) * [Deployment Guide](https://grafana.com/docs/pyroscope/latest/deploy-kubernetes/) * [Pyroscope Architecture](https://grafana.com/docs/pyroscope/latest/reference-pyroscope-architecture/) ## 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](https://grafana.com/docs/pyroscope/latest/configure-client/) on our website or find language specific examples and documentation below:

Golang

Documentation
Examples

Java

Documentation
Examples

Python

Documentation
Examples

Ruby

Documentation
Examples

Node.js

Documentation
Examples

.NET

Documentation
Examples

eBPF

Documentation
Examples

Rust

Documentation
Examples
## [Supported Languages][supported languages] Our documentation contains the most recent list of [supported languages] and also an overview over what [profiling types are supported per language][profile-types-languages]. Let us know what other integrations you want to see in [our issues](https://github.com/grafana/pyroscope/issues?q=is%3Aissue+is%3Aopen+label%3Anew-profilers) or in [our slack](https://slack.grafana.com). [supported languages]: https://grafana.com/docs/pyroscope/latest/configure-client/ [profile-types-languages]: https://grafana.com/docs/pyroscope/latest/configure-client/profile-types/ ## 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, Daniel Borkmann, 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](docs/internal/contributing/README.md) ### Thanks to the contributors of Pyroscope! [//]: contributor-faces [//]: contributor-faces